Empresas

Criar empresas em lote

Endpoint que cria empresas em lote.

{danger.fa-close} Endpoint depreciado, será removido em breve

Method URI Headers Authorization
POST /api/v3/companies-save-many Content-Type:application/json Authorization: Bearer {token}

Attributes

empresas: [] (array) - "Array com os dados das empresas",
empresas.*.nome_social: 'Aguiar Comercial Ltda' (integer) - "Nome Social da Empresa",
empresas.*.nome: 'Brito e Filhos' (string) - "Nome Fantasia da Empresa",
empresas.*.cnpj: 81722252000126 (integer) - "CNPJ da Empresa",
empresas.*.endereco: 'Av. Luis, 43' (string) - "Endereço da Empresa",
empresas.*.numero: 1099 - "Numéro do endereço da Empresa",
empresas.*.complemento: 'loja 2' (string) - "Complemento do endereço da Empresa",
empresas.*.bairro: 'Bairro' (string) - "Bairro onde a empresa está localizada",
empresas.*.cep: '13213-1231' (string) - "Cep da Empresa",
empresas.*.city_id: 1 (integer) - "Id da cidade",
empresas.*.state_id: 1 (integer) - "Id do Estado",
empresas.*.contato_nome: 'Nome Contato' (string) - "Nome do contato da Empresa",
empresas.*.contato_fixo: '9999-9999' (string) - "Telefone Fixo do Contato da Empresa",
empresas.*.contato_celular: '9999-9999' (string) - "Telefone Celular do Contato da Empresa",
empresas.*.contato_email: 'nome.contato@zordon.com.br' (string) - "E-mail do Contato da Empresa",
empresas.*.cnae: '1234-5/67 '(string) - "Código CNAE da Empresa",
empresas.*.codigo_unidade_consumidora: '12345-500' (string) - "Código da Unidade Consumidora",
empresas.*.parent_id: 1 (integer) - "Empresa Matriz",
empresas.*.id_externo: '123456789' (string) - "Id Externo da Empresa"
empresas.*.source: 'doc88' - (string) - "Nome da fonte que está criando o registro. Valores permitidos: comerc, doc88 ou zordon"


Response

{success} Response 200 (application/json)

{
    "cadastros realizados com sucesso!"
}

{warning} Response 422 (application/json)

{
  "nome_social": [
    "O campo Nome Social é obrigatório."
  ],
  "endereco": [
    "O campo Endereço é obrigatório."
  ],
  "cep": [
    "O campo cep é obrigatório."
  ],
  "numero": [
    "O campo numero é obrigatório."
  ],
  "city_id": [
    "O campo Cidade é obrigatório."
  ],
  "state_id": [
    "O campo Estado é obrigatório."
  ],
  "contato_nome": [
    "O campo Contato Nome é obrigatório."
  ],
  "contato_fixo": [
    "O campo Contato Tel. Fixo é obrigatório."
  ],
  "contato_celular": [
    "O campo Contato Celular é obrigatório."
  ],
  "contato_email": [
    "O campo Contato Email é obrigatório."
  ]
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Pegar uma empresa pelo Id Externo

Endpoint que pega uma empresa específica pelo id externo.

{danger.fa-close} Endpoint depreciado, será removido em breve

Method URI Headers Authorization
GET /api/v3/companies-external/321654 Content-Type:application/json Authorization: Bearer {token}

Parameters

external_id: 321654 (integer) - "Id externo da Empresa"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "cnpj": "76539975524249",
    "nome_social": "Aguiar Comercial Ltda",
    "nome": "Brito e Filhos",
    "contato_nome": "(35) 98928-1608",
    "contato_email": "lucas.arruda@vale.com.br",
    "contato_celular": "(81) 3286-4674",
    "codigo_unidade_consumidora": "59199-068",
    "city_id": 5646,
    "state_id": 103,
    "endereco": "Av. Luis",
    "numero": "1099",
    "complemento": null,
    "bairro": "São Agostinho d'Oeste",
    "cep": "80512-551",
    "parent_id": null,
    "cnae": "6077-8\/44",
    "empresa_pai_id": null,
    "parent": null,
    "city": {
        "id": 5646,
        "name": "Batista d'Oeste"
    },
    "state": {
        "id": 103,
        "name": "Tocantins",
        "uf": "do Sul"
    },
    "energy_demands_off_peak": [
        {
            "id": 6,
            "company_id": 4,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "off_peak",
            "amount": 13982136.0046
        }
    ],
    "energy_demands_peak": [
        {
            "id": 1,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 996499.6556
        },
        {
            "id": 2,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 3022800.6467
        }
    ]
}

{warning} Response 404 (application/json)

{
  "errors": {
    "error": "Houve um problema ao buscar este registro."
  }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Pegar uma empresa pelo CNPJ

Endpoint que pega uma empresa específica pelo cnpj.

{danger.fa-close} Endpoint depreciado, será removido em breve

Method URI Headers Authorization
GET /api/v3/companies-cnpj/15672342000125 Content-Type:application/json Authorization: Bearer {token}

Parameters

cnpj: 15672342000125 (integer) - "CNPJ da Empresa"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "cnpj": "76539975524249",
    "nome_social": "Aguiar Comercial Ltda",
    "nome": "Brito e Filhos",
    "contato_nome": "(35) 98928-1608",
    "contato_email": "lucas.arruda@vale.com.br",
    "contato_celular": "(81) 3286-4674",
    "codigo_unidade_consumidora": "59199-068",
    "city_id": 5646,
    "state_id": 103,
    "endereco": "Av. Luis",
    "numero": "1099",
    "complemento": null,
    "bairro": "São Agostinho d'Oeste",
    "cep": "80512-551",
    "parent_id": null,
    "cnae": "6077-8\/44",
    "empresa_pai_id": null,
    "parent": null,
    "city": {
        "id": 5646,
        "name": "Batista d'Oeste"
    },
    "state": {
        "id": 103,
        "name": "Tocantins",
        "uf": "do Sul"
    },
    "energy_demands_off_peak": [
        {
            "id": 6,
            "company_id": 4,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "off_peak",
            "amount": 13982136.0046
        }
    ],
    "energy_demands_peak": [
        {
            "id": 1,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 996499.6556
        },
        {
            "id": 2,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 3022800.6467
        }
    ]
}

{warning} Response 404 (application/json)

{
  "errors": {
    "error": "Houve um problema ao buscar este registro."
  }
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Associar uma empresa existente a um Id Externo

Endpoint que associa uma empresa a um id Externo.

{danger.fa-close} Endpoint depreciado, será removido em breve

Method URI Headers Authorization
POST /api/v3/companies-external-associate Content-Type:application/json Authorization: Bearer {token}

Attributes

company_id: 1 (integer, required) - "Id da Empresa",
external_id: '123456' (string, required) - "Id Externo",
source: 'doc88' - (string, required) - "Nome da fonte que está criando a associação. Valores permitidos: comerc, doc88 ou zordon"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "cnpj": "76539975524249",
    "nome_social": "Aguiar Comercial Ltda",
    "nome": "Brito e Filhos",
    "contato_nome": "(35) 98928-1608",
    "contato_email": "lucas.arruda@vale.com.br",
    "contato_celular": "(81) 3286-4674",
    "codigo_unidade_consumidora": "59199-068",
    "city_id": 5646,
    "state_id": 103,
    "endereco": "Av. Luis",
    "numero": "1099",
    "complemento": null,
    "bairro": "São Agostinho d'Oeste",
    "cep": "80512-551",
    "parent_id": null,
    "cnae": "6077-8\/44",
    "empresa_pai_id": null,
    "parent": null,
    "city": {
        "id": 5646,
        "name": "Batista d'Oeste"
    },
    "state": {
        "id": 103,
        "name": "Tocantins",
        "uf": "do Sul"
    },
    "energy_demands_off_peak": [
        {
            "id": 6,
            "company_id": 4,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "off_peak",
            "amount": 13982136.0046
        }
    ],
    "energy_demands_peak": [
        {
            "id": 1,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 996499.6556
        },
        {
            "id": 2,
            "company_id": 1,
            "vigency_start": "2021-04-10",
            "vigency_end": "2021-04-10",
            "type": "peak",
            "amount": 3022800.6467
        }
    ]
}

{warning} Response 422 (application/json)

{
    "company_id": [
        "O campo empresa selecionado é inválido."
    ],
    "external_id": [
        "O campo external id deve ser uma string."
    ],
    "source": [
        "O campo source deve ser uma string.",
        "O campo source selecionado é inválido."
    ]
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.