Nota Fiscal

Consulta

Consulte os dados editáveis de uma nota fiscal na API Frete Barato.

O endpoint de get consulta os dados editáveis de uma nota fiscal: totais, transporte, destino e status. Use a resposta para montar a edição da nota com os valores atuais.

A consulta funciona para qualquer nota cujo emitente seja um CNPJ da conta, de qualquer origem: pedidos criados pela API, notas enviadas pelo push, notas importadas por e-mail ou por integrações.

Endpoint

https://admin.fretebarato.com/invoice/get/v1/json/{{customer_id}}

Consulte uma nota fiscal

curl -X GET "https://admin.fretebarato.com/invoice/get/v1/json/{{customer_id}}?id_fatura_nota_fiscal=987654&emitente_cnpj=12345678000199" \
  -H "Authorization: Bearer xxxxxxxxxxxx" \
  -H "User-Agent: MinhaAplicacao ([email protected])"

$url = "https://admin.fretebarato.com/invoice/get/v1/json/{{customer_id}}?id_fatura_nota_fiscal=987654&emitente_cnpj=12345678000199";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
  "Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxx",
  "User-Agent: MinhaAplicacao ([email protected])"
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($curl);
curl_close($curl);

{
  "success": true,
  "code": 200,
  "message": "Invoice loaded successfully",
  "data": {
    "id_fatura_nota_fiscal": 987654,
    "emitente_cnpj": "12345678000199",
    "total_nf": "150.50",
    "total_frete": "10.00",
    "transporte_volume_quantidade": 2,
    "transporte_volume_peso_bruto": "1.250",
    "transporte_volume_peso_liquido": "1.100",
    "transporte_cnpj": "11222333000181",
    "transporte_nome": "Transportadora Exemplo Ltda",
    "transporte_nome_alias": "Exemplo",
    "destino_endereco_cep": "01310100",
    "destino_endereco_uf": "sp",
    "destino_endereco_bairro": "Bela Vista",
    "destino_endereco_logradouro": "Avenida Paulista",
    "destino_endereco_numero": "1000",
    "destino_endereco_complemento": "Sala 12",
    "destino_nome": "Maria Silva",
    "destino_endereco_telefone": "11987654321",
    "status_code": 5,
    "can_update_order": true,
    "can_delete_volumes": false
  }
}

Headers

Key	Value
`Authorization`	`Bearer {{token}}`
`User-Agent`	Aplicação (e-mail para contato técnico)

Parâmetros da query

Parâmetro	Tipo	Obrigatório	Observação
`id_fatura_nota_fiscal`	Numérico	Sim	Identificador da nota
`emitente_cnpj`	String	Sim	CNPJ do emitente da nota, com 14 dígitos (aceita pontuação). Precisa ser um CNPJ cadastrado na conta
`id_cliente`	Numérico	Não	Não é necessário. Se enviado, precisa ser o da conta autenticada

Parâmetros do response

Parâmetro	Tipo	Comportamento
`success`	Boolean	Indica se a requisição foi processada com sucesso (`true`/`false`)
`code`	Numérico	Retorna o código HTTP da resposta
`message`	String	Mensagem descritiva sobre o resultado da consulta
`data.id_fatura_nota_fiscal`	Numérico	Identificador da nota
`data.emitente_cnpj`	String	CNPJ do emitente
`data.total_nf`	String	Valor total da nota, com 2 casas decimais (ex: `"150.50"`)
`data.total_frete`	String	Valor do frete, com 2 casas decimais
`data.transporte_volume_quantidade`	Numérico	Quantidade de volumes
`data.transporte_volume_peso_bruto`	String	Peso bruto, com 3 casas decimais (ex: `"1.250"`)
`data.transporte_volume_peso_liquido`	String	Peso líquido, com 3 casas decimais
`data.transporte_cnpj`	String	CNPJ da transportadora
`data.transporte_nome`	String	Nome da transportadora
`data.transporte_nome_alias`	String	Nome alternativo da transportadora
`data.destino_*`	String	Dados do destino (CEP, UF, bairro, logradouro, número, complemento, nome e telefone). Valores vindos da NF-e mantêm a forma do XML; a UF, por exemplo, fica em minúsculas
`data.status_code`	Numérico	Código do status atual do pedido
`data.can_update_order`	Boolean	`true` quando o CNPJ da transportadora pode ser alterado. `false` com o pedido em transporte ou entregue
`data.can_delete_volumes`	Boolean	`true` quando a nota já tem volumes gerados e a troca do CNPJ da transportadora remove esses volumes

Trate os erros

Response	Tipo	Mensagem	Descrição
`400`	Bad Request	ID da nota fiscal é obrigatório.	`id_fatura_nota_fiscal` ausente, zero ou inválido
`400`	Bad Request	CNPJ do emitente é obrigatório.	`emitente_cnpj` ausente ou sem 14 dígitos
`400`	Bad Request	Nota fiscal inconsistente (emitente_cnpj).	O emitente da nota é diferente do `emitente_cnpj` enviado
`401`	Unauthorized	Authentication failure	Falha na autenticação: token inválido, Customer ID incorreto ou versão incorreta da API
`403`	Forbidden	Cliente inconsistente (id_cliente).	`id_cliente` enviado diferente da conta autenticada
`403`	Forbidden	Você não tem permissão para acessar este recurso.	O CNPJ do emitente não pertence à conta
`404`	Not Found	Customer not found	Customer ID sem conta associada
`404`	Not Found	Cliente não encontrado.	Cadastro da conta não localizado. Fale com o suporte
`404`	Not Found	Nota fiscal não encontrada.	Não existe nota com esse identificador
`406`	Not Acceptable	Invalid Params (JSON)	Estrutura JSON inválida ou malformada

Exemplos de erro

{
  "success": false,
  "code": 400,
  "message": "ID da nota fiscal é obrigatório.",
  "data": null
}

{
  "success": false,
  "code": 400,
  "message": "Nota fiscal inconsistente (emitente_cnpj).",
  "data": null
}

{
  "success": false,
  "code": 401,
  "message": "Authentication failure",
  "data": null
}

{
  "success": false,
  "code": 404,
  "message": "Nota fiscal não encontrada.",
  "data": null
}

Envio

Envie Notas Fiscais Eletrônicas (NF-e) em Base64 para a API Frete Barato.

Edição

Altere os dados de transporte, destino e totais de uma nota fiscal na API Frete Barato.