Fatura um pedido e informa seus dados fiscais
POSThttps://erp.hub.it4360.com/api/v1/orders/{id}/invoicing
Este endpoint permite faturar um pedido e informar seus dados fiscais.
Rate limit
| Quantidade de Requisições | Tempo em Segundos |
|---|---|
| 120 | 60 |
Parâmetros
| Parâmetro | Tipo | Localização | Descrição | Obrigatório |
|---|---|---|---|---|
| id | string | Path | O ID único do pedido que você deseja marcar como integrado. | Sim |
| IdDataSourceCompanyBranch | string | Header | Identificador da Company Branch. | Sim |
| Authorization | string | Header | Token de autenticação. | Sim |
| body | Objeto JSON | Corpo | O objeto de requisição que contém os parâmetros necessários para faturar o pedido. | Sim |
Exemplo de corpo da Requisição
{
"number": "string",
"series": "string",
"key": "string",
"tracking": {
"code": "string",
"url": "string"
},
"issuanceDate": "2023-10-10T16:21:01.833Z",
"nature": "string",
"weight": 0,
"icmsTax": "string",
"cfopTax": "string",
"nfeXml": "string",
"nfeUrl": "string",
"volumes": 0,
"orderItemInvoiceProperties": [
{
"idOrderItem": "string",
"key": "string",
"value": "string"
}
]
}Atributos do corpo da Requisição
| Atributo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| number | string | Número da fatura | Sim |
| series | string | Série da fatura | Sim |
| key | string | Chave da fatura | Sim |
| tracking | objeto | Informações de rastreamento | Não |
| - code | string | Código de rastreamento | Sim |
| - url | string | URL de rastreamento | Sim |
| issuanceDate | string | Data de emissão da fatura no formato ISO 8601 | Não |
| nature | string | Natureza da fatura | Não |
| weight | number | Peso da fatura | Sim |
| icmsTax | string | Imposto ICMS da fatura | Não |
| cfopTax | string | CFOP (Código Fiscal de Operações e Prestações) | Não |
| nfeXml | string | XML da Nota Fiscal Eletrônica | Não |
| nfeUrl | string | URL da Nota Fiscal Eletrônica | Não |
| volumes | number | Quantidade de volumes da fatura | Sim |
| orderItemInvoiceProperties | array | Propriedades do item da fatura | Não |
| - idOrderItem | string | ID do item da fatura | Não |
| - key | string | Chave do item da fatura | Sim |
| - value | string | Valor do item da fatura | Sim |
Exemplos de Requisição
curl --location 'https://erp.hub.it4360.com/api/v1/orders/00007ae8-9aab-4454-8c5b-7534694aa7a6/invoicing' \
--header 'IdDataSourceCompanyBranch: 00004c77-7d99-4d9e-8f3b-933d8344863b' \
--header 'Content-Type: application/json' \
--header 'Accept: text/plain' \
--header 'Authorization: Bearer token-de-autorizacao' \
--data '{
"key": "35210504302429200157550012345218361180025324",
"number": "21639",
"series": "8",
"volumes": "1",
"weight": 1000.00,
"tracking": {
"code": "IP775957031BR",
"url": "https://exemplo.com/track?codigo=IP775957031BR"
},
"issuanceDate": "2023-10-10T12:16:34.220",
"nature": "6109",
"icmsTax": "15.27",
"cfopTax": "03",
"nfeXml": "<nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"> <NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"> </NFe> <protNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"> </protNFe></nfeProc>",
"nfeUrl": "https://exemplo/danfe-pdf/40434.pdf",
"orderItemInvoiceProperties": [
{
"key": "IMEI",
"value": "678958526264267",
"idOrderItem": "6dc779a4-898a-4219-7y7b-5582230a93d2"
},
{
"key": "IMEI",
"value": "255798595657771",
"idOrderItem": "34b968rf-e8c6-494c-b616-d8e425bdaf76"
}
]
}'Respostas
-
204 No Content - Sucesso. O pedido foi faturado com sucesso.
-
400 Bad Request - Não foi possível atender à requisição. Valide os dados informados.
Corpo da Resposta (Exemplo):
"Mensagem de erro detalhada." -
404 Not Found - Não encontrado. O pedido não pôde ser encontrado.
Corpo da Resposta (Exemplo):
"Pedido não encontrado."