Atenção: O endpoint de notas fiscais acessado pela url
/v1/nota_fiscalestá depreciado. Novas homologações devem ser realizadas na versão 2(/v2/nota_fiscal). A versão 1 não receberá mais atualizações e com o tempo deixará de ser suportada.
Na entidade de Notas Fiscais são armazenadas as notas fiscais de cada cliente. Essas informações são utilizadas para apresentar a 2ª via da nota fiscal no e-commerce B2B.
Observação: Notas Fiscais excluídas não serão exibidas em tela para o usuário.
Estrutura de Retorno do GET
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único. |
| empresa_id | Integer | Identificador único da empresa. |
| valor | Decimal | Valor da nota fiscal. Ex: 9999999.99 |
| numero | String | Número da nota fiscal. Ex: "123456789" (9 posições) |
| link_pdf | String | Link do arquivo PDF. |
| ultima_alteracao | Date | Data da última alteração da nota fiscal. Ex: 2023-07-12 |
| pedido_id | Integer | ID do pedido associado à nota fiscal. |
| cliente_id | Integer | ID do cliente associado à nota fiscal. |
| excluido | Boolean | Indica que a nota fiscal está excluída. |
| serie | String | Série da nota fiscal. Ex: "001" (3 posições) |
| link_xml | String | Link do arquivo XML em base 64. |
| data_criacao | Date | Data da criação da nota fiscal no Mercos. Ex: 2023-07-12 |
| data_emissao | Date | Data de emissão da nota fiscal. Ex: 2023-07-12 |
| chave_acesso | String | Chave de acesso da nota fiscal. Ex: 11111111111111111111111111111111111111111111 (44 posições) |
Parâmetros do JSON de Envio de Nota Fiscal
| Campo | Tipo | Descrição |
|---|---|---|
| numero (obrigatório) | String: 9 | Número da nota fiscal. Ex: "123456789" |
| serie (obrigatório) | String: 3 | Série da nota fiscal. Ex: "001" |
| chave_acesso (obrigatório) | String: 44 | Chave de acesso da nota fiscal. Ex: 11111111111111111111111111111111111111111111 |
| valor (obrigatório) | Decimal: 2 casas decimais | Valor da nota fiscal. Ex: 9999999.99 |
| data_emissao (obrigatório) | Date | Data de emissão da nota fiscal. Ex: 2023-07-12 |
| arquivo_xml (obrigatório*) | String | String base 64 do arquivo XML. |
| link_xml (obrigatório*) | String | Link do arquivo XML em base 64. |
| arquivo_pdf | String | String base 64 do arquivo PDF. |
| link_pdf | String | Link do arquivo PDF em base 64. |
| cliente_id (obrigatório) | Integer | ID do cliente associado à nota fiscal. |
| pedido_id | Integer | ID do pedido associado à nota fiscal. |
| excluido | Boolean | Indica que a nota fiscal está excluída. |
*Obs.: É obrigatório o envio do XML, seja via
arquivo_xmloulink_xml. Caso ambos sejam enviados, será considerado apenas olink_xml. Da mesma forma, casolink_pdfearquivo_pdfsejam enviados simultaneamente, será considerado apenas olink_pdf.