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.
Importante:
- Para obter as notas fiscais (GET), é no formato
application/json.- Criação e alteração de notas fiscais (POST/PUT), é no formato
multipart/form-data.- Para atualizar a nota fiscal utilize o PUT informando o id da nota fiscal na URL (
/api/v2/nota_fiscal/{nota_fiscal_id}/.- Permite o envio de arquivos xml e pdf em até
5mbcada.- É obrigatório o envio do
xml, seja oarquivo_xmlou olink_xml. Caso sejam enviados os camposlink_xmlearquivo_xml, será considerado apenas o campolink_xml.- Caso sejam enviados os campos
link_pdfearquivo_pdf, será considerado apenas o campolink_pdf.
- Para obter as notas fiscais (GET), é no formato
application/json.- Criação e alteração de notas fiscais (POST/PUT), é no formato
multipart/form-data.- Para atualizar a nota fiscal utilize o PUT informando o id da nota fiscal na URL (
/api/v2/nota_fiscal/{nota_fiscal_id}/.- Permite o envio de arquivos xml e pdf em até
5mbcada.- É obrigatório o envio do
xml, seja oarquivo_xmlou olink_xml. Caso sejam enviados os camposlink_xmlearquivo_xml, será considerado apenas o campolink_xml.- Caso sejam enviados os campos
link_pdfearquivo_pdf, será considerado apenas o campolink_pdf.
Estrutura da Resposta (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único. |
| empresa_id | Integer | Identificador único. |
| valor | Decimal | Valor da nota fiscal. Ex: 9999999.99 |
| numero | String | Número da nota fiscal. Ex: "123456789" (tamanho 9 posições). |
| link_pdf | String | Link do arquivo. |
| ultima_alteracao | Date | Data da última alteração da nota fiscal. Ex: 2023-07-12. |
| pedido_id | Integer | ID do pedido associado a nota fiscal. |
| cliente_id | Integer | ID do cliente associado a nota fiscal. |
| excluido | Boolean | Indica que a nota fiscal está excluída. |
| serie | String | Série da nota fiscal. Ex. "001" (tamanho 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 (tamanho 44 posições) |
Parâmetros de Envio (POST)
| Chave | Tipo | Descrição |
|---|---|---|
| arquivo_pdf | File | Arquivo PDF da nota fiscal |
| arquivo_xml | File | Arquivo XML da nota fiscal |
| nota_fiscal | Text | String em formato JSON das demais informações da nota fiscal (campos descritos abaixo) |
Informações da 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 (tamanho 44 posições) |
| 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 |
| link_xml (obrigatório*) | String | Link do arquivo XML em base 64 |
| link_pdf | String | Link do arquivo PDF em base 64 |
| cliente_id (obrigatório) | Integer | ID do cliente associado a nota fiscal. |
| pedido_id | Integer | ID do pedido associado a nota fiscal. |
| excluido | Boolean | Indica que a nota fiscal está excluída. |
Exemplo (curl)
curl --location '{url}/api/v2/nota_fiscal' \
--header 'ApplicationToken: {applicatonToken}' \
--header 'CompanyToken: {companyToken}' \
--header 'Content-Type: multipart/form-data' \
--form 'arquivo_pdf=@"{caminho_arquivo}"' \
--form 'arquivo_xml=@"{caminho_arquivo}"' \
--form 'nota_fiscal="{\"numero\":\"987654321\",\"serie\":\"032\",\"chave_acesso\":\"22222111111111111111111111111111111111111111\",\"valor\":20.02,\"data_emissao\":\"2023-02-16\",\"cliente_id\":6,\"excluido\":false}"'