Histórico da Página
...
Parâmetros do Corpo (Body Parameters)
| PARÂMETRO | TIPO | DESCRIÇÃO |
|---|---|---|
| ID | String | Identificador único da venda |
| Version | String | Versão da API |
| Sale | Object Json | Venda |
| Sale.Increase | Currency | Acréscimo aplicado na venda |
| Sale.Discount | Currency | Desconto aplicado no venda |
| Sale.ID | String | Identificador único da venda |
| Sale.Sale.Total | Currency | Valor total da venda |
| Sale.header | Object Json | Cabeçalho da venda |
| Sale.header.idStore | Integer | Identificador da loja que gerou a venda |
| Sale.header.idTerminal | Integer | Identificador do terminal/checkout que gerou a venda |
| Sale.header.idDocument | Integer | Identificador da venda |
| Sale.header.idUser | Integer | Identificador do operador que realizou a venda |
| Sale.header.status | String | Status da venda sttValid - Vendido sttCanceled - Cancelada |
| Sale.header.idInvoiceKey | String | Chave da venda gerada para acessar o documento na SEFAZ |
| Sale.header.accountingDate | Date | Data da emissão da venda |
| Sale.header.dateTimeIssue | DateTime | Data e hora da emissão da venda |
| Sale.payments | Array object Json | Lista de pagamentos |
| Sale.payments[0].increase | Currency | Acréscimo aplicado no pagamento |
| Sale.payments[0].Discount | Currency | Desconto aplicado no pagamento |
| Sale.payments[0].total | Currency | Valor pago |
| Sale.payments[0].paymentType | String | Espécie de pagamento cptMoney - Espécie dinheiro; cptDebitCard - Espécie cartão de débito; cptCreditCard - Espécie cartão de crédito; cptBillet - Espécie boleto; cptCheck - Espécie cheque; cptPOS - Espécie POS; cptAgreement - Espécie convênio; cptPromissoryNote - Espécie nota promissório; cptFinancialCredit - Espécie crédito financeira; cptWorthDebit - Espécie vale débito; cptDigitalWallet - Espécie carteira digital; |
| Sale.payments[0].paymentNumber | Integer | Número da forma de pagamento |
| Sale.payments[0].dateTimeIssue | DateTime | Data e hora do pagamento |
| Sale.items | Array object Json | Item da venda |
| Sale.items[0].internalCode | Integer | Código interno do item |
| Sale.items[0].itemNumber | Integer | Código item na venda |
| Sale.items[0].status | String | Status do item sttValid - Vendido sttCanceled - Cancelada |
| Sale.items[0].unitPrice | Currency | Valor unitário do item |
| Sale.items[0].increasePrice | Currency | Acréscimo aplicado no item |
| Sale.items[0].discountPrice | Currency | Desconto aplicado no item |
| Sale.items[0].captionPacking | String | Descrição da unidade |
| Sale.items[0].barCode | String | EAN do produto vendido |
| Sale.items[0].quantity | Integer | Quantidade do item |
| Sale.items[0].description | String | Descrição do item |
| Sale.items[0].totalPrice | Currency | Valor total liquido do item |
| Sale.items[0].sellerCode | Integer | Código do vendedor |
| Sale.items[0].idSegment | Integer | Identificador no segmento do item |
| Sale.items[0].dateTimeIssue | DateTiem | Data e hora e emissão do item |
Formatos de Requisição (Request Formats)
...
Parâmetros do Corpo (Body Parameters)
| PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| documents | Object Json | Sim | Tipos de documento do cliente
| ||||||||||
| Name | String | 50 | Sim | Nome | |||||||||
| String | 80 | Não | Email do cliente | ||||||||||
| Kind | String | Sim | Tipo de pessoa cktPhysical - Física | ||||||||||
| Taxpayer | String | Não | Contribuinte de ICMS yntYes - Sim | ||||||||||
| PublicAgency | String | Não | Órgão público yntYes - Sim | ||||||||||
| TaxRegime | Integer | 5 | Não | Regime de tributação | |||||||||
| GlobalLimit | Double | 9, 2 | Não | Valor limite global | |||||||||
| Deadline | Integer | 3 | Não | Prazo máximo em dias | |||||||||
| CreditStatus | String | Não | Situação do crédito ccsAlert - Alerta | ||||||||||
| Note | String | 250 | Não | Observação | |||||||||
| CardNumber | Integer | 15 | Não | Número do cartão | |||||||||
| BusinessSituation | String | Não | Situação comercial bstReleased - Liberado | ||||||||||
| KindAddress | String | Sim | Tipo do endereço katMain - Principal | ||||||||||
| PublicPlace | String | 60 | Sim | Descrição do logradouro | |||||||||
| PublicPlaceNumber | String | 10 | Não | Número do logradouro | |||||||||
| Neighbourhood | String | 50 | Sim | Descrição do bairro | |||||||||
| Complement | String | 60 | Não | Complemento de endereço | |||||||||
| City | String | 60 | Sim | Nome da cidade | |||||||||
| FederativeUnit | String | 2 | Sim | Estado da cidade | |||||||||
| ZipCode | Integer | 8 | Sim | Cep sem formatação | |||||||||
| IBGE | Integer | 12 | Não | Código da cidade no IBGE |
Formatos de Resposta (Response Formats)
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas