Endpoint criado para cadastro, edição, consulta e remoção de pedidos externos (histórico financeiro).Cabeçalho do Pedido Externo#
| Campo | Tipo | Obrigatório | Descrição |
|---|
| code | varchar | Sim | Código de identificação do pedido |
| client_cpfj | varchar | Sim | CPF ou CNPJ do cliente que realizou o pedido, enviar sem caracteres especiais |
| status | varchar | Não | Situação do pedido (Em processamento, Finalizado, etc...) |
| total_value | decimal | Sim | Valor total |
| freight_value | decimal | Não | Valor do frete |
| taxes_total_value | decimal | Não | Valor total dos impostos |
| taxes_ipi_value | decimal | Não | Valor do IPI |
| taxes_pis_cofins_value | decimal | Não | Valor do PIS/COFINS |
| taxes_st_value | decimal | Não | Valor do ST |
| items | array | Sim | Conjunto de itens do pedido |
| invoices | array | Não | Conjunto de notas fiscais do pedido |
| bankbills | array | Não | Conjunto de boletos do pedido |
Itens do Pedido#
| Campo | Tipo | Obrigatório | Descrição |
|---|
| product_code | varchar | Sim | Código do produto |
| product_name | varchar | Sim | Nome do produto |
| quantity | inteiro | Sim | Quantidade solicitada |
| unitary_value | decimal | Sim | Valor unitário do produto |
| total_value | decimal | Não | Valor total do produto |
| freight_value | decimal | Não | Valor do frete do produto |
| tax_total_value | decimal | Não | Valor total de impostos do produto |
| tax_ipi_value | decimal | Não | Valor do IPI do produto |
| tax_pis_cofins_value | decimal | Não | Valor do PIS/COFINS do produto |
| tax_icms_value | decimal | Não | Valor ICMS do produto |
| tax_st_value | decimal | Não | Valor ST do produto |
Notas do Pedido#
| Campo | Tipo | Obrigatório | Descrição |
|---|
| number | varchar | Sim | Número da nota |
| serie | varchar | Não | Série da nota |
| key | varchar | Não | Chave da nota |
| date | date | Não | Data de emissão da nota (formato: YYYY-mm-dd) |
| base64_file | texto-longo | Não | Conteúdo do arquivo de XML da nota ou DANFE convertido em base64 |
Boletos do Pedido#
| Campo | Tipo | Obrigatório | Descrição |
|---|
| base64_file | texto-longo | Não | Conteúdo do arquivo de boleto convertido em base64 |
Modificado em 2025-06-23 20:17:41