...
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.header.identification | Array object Json | Lista de identificação do consumidor ou cliente |
Sale.header.identification.document | String | Documento do cliente ou consumidor |
Sale.header.identification.partnerCode | String | Código do parceiro |
Sale.header.identification.documentType | String | Tipo do documento (CPF ou CNPJ) |
Sale.header.identification.identificationType | String | Tipo de identificação (citUnknown, citInternal, citInvoice, citReward) |
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.payments[0].AuthorizationCode | String | Numero da autorização TEF |
Sale.payments[0].TransactionCanceledCode | String | Numero da autorização cancelamento TEF |
Sale.payments[0].TransactionCode | String | Número do NSU host |
Sale.payments[0].TypeWallet | String | Tipo da carteira digital |
Sale.paymentChange | Array object Json | Lista informações de Troco |
Sale.paymentChange.increase | Currency | Acréscimo no troco |
Sale.paymentChange.installmentAmount | Integer | Qtde parcela do TEF |
Sale.paymentChange.itemNumber | Integer | Item do troco sequência |
Sale.paymentChange.total | Currency | Valor total do troco |
Sale.paymentChange.discount | Currency | Desconto no troco |
Sale.paymentChange.paymentType | String | **Mesmo dos pagamentos - Sale.payments[0].paymentType |
Sale.paymentChange.paymentNumber | Integer | Número da forma de pagamento |
Sale.paymentChange.dateTimeIssue | DateTime | Data e hora do troco |
Sale.paymentChange.AuthorizationCode | String | Numero da autorização TEF |
Sale.paymentChange.TransactionCanceledCode | String | Numero da autorização cancelamento TEF |
Sale.paymentChange.TransactionCode | String | Número do NSU host |
Sale.paymentChange.TypeWallet | String | Tipo da carteira digital |
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 |
Sale.Items[0].Scale | Boolean | Indica se o produto é pesável |
Sale.Items[0].partitionDiscount | Array object Json | Lista de desconto dado no item |
Sale.Items[0].partitionDiscount.price | Currency | Desconto do item |
Sale.Items[0].partitionDiscount.partnerCode | Integer | Código do parceiro que aplicou o desconto |
Sale.Items[0].partitionDiscount.promotionCode | Integer | Código de promoção |
Sale.Items[0].partitionDiscount.discountAmount | Integer | Quantidade do item |
Sale.Items[0].partitionIncrease | Array object Json | Lista de acréscimo dado no item |
Sale.Items[0].partitionIncrease.price | Currency | Desconto do item |
Sale.Items[0].partitionIncrease.partnerCode | Integer | Código do parceiro que aplicou o desconto |
Sale.Items[0].partitionIncrease.promotionCode | Integer | Código de promoção |
Sale.Items[0].partitionIncrease.discountAmount | Integer | Quantidade do item |
Exemplo (Sample)
...
language | actionscript3 |
---|
...
{
"iD": "
...
001906000030549",
...
"pay": null,
"version": 1,
...
"sale": {
...
"iD": "
...
001906000030549",
...
"increase": 0,
...
"discount": 0,
...
"total":
...
10.85,
"header": {
...
"idStore": 1,
...
"idTerminal":
...
906,
"idDocument":
...
30549,
"idUser": 2,
...
"status": "sttValid",
...
"idInvoiceKey": "
...
29230707363764000352650560000000129168118489",
...
"accountingDate": "
...
2023-
...
07-
...
05T00:00:00.000Z",
...
"dateTimeIssue": "
...
2023-
...
07-
...
05T13:
...
48:
...
59.000Z",
"identification": [
{
"document": "04620339610",
"partnerCode": 25,
"documentType": "cdtCPF",
"identificationType": "citReward"
}
]
},
"payments": [
{
"increase": 0,
"installmentAmount": 0,
"itemNumber": 1,
"total": 20,
"discount": 0,
"paymentType": "cptMoney",
...
"paymentNumber": 1,
...
"dateTimeIssue": "
...
2023-
...
07-
...
05T13:
...
49:
...
51.000Z"
...
}
],
"paymentChange": {
"increase": 0,
"installmentAmount": 0,
"itemNumber": 2,
"total": -9.15,
"discount": 0,
"paymentType": "cptMoney",
"paymentNumber": 1,
"dateTimeIssue": "1899-12-30T00:00:00.000Z"
},
"items": [
{
"internalCode": "19359",
"itemNumber": 1,
"status": "sttValid",
"unitPrice": 12.85,
"increasePrice": 0,
"captionPacking": "UN",
"packingQuantity": 1,
"barCode": "111111",
"quantity": 1,
"description": "ABACAXI EM CALDA DELAKASA DIET 400G",
"totalPrice": 10.85,
"discountPrice": 2,
"sellerCode": 0,
"idSegment": 3,
"dateTimeIssue": "2023-07-05T13:49:09.000Z",
"partitionDiscount": [
{
"price": 2,
"partnerCode": 0,
"promotionCode": 0,
"discountAmount": 0
}
],
"scale": false
}
],
"messages": null,
"solidaryChange": null
},
"event": "cetAfter",
"operation": "cotEndSale",
"execution": "cetContinue",
"parkingTicket": null
}
...