...
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.cooDocument | Integer | Coo do documento |
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[0].document | String | Documento do cliente ou consumidor |
Sale.header.identification[0].partnerCode | String | Código do parceiro |
Sale.header.identification[0].documentType | String | Tipo do documento (CPF ou CNPJ) |
Sale.header.identification[0].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[0].increase | Currency | Acréscimo no troco |
Sale.paymentChange[0].installmentAmount | Integer | Qtde parcela do TEF |
Sale.paymentChange[0].itemNumber | Integer | Item do troco sequência |
Sale.paymentChange[0].total | Currency | Valor total do troco |
Sale.paymentChange[0].discount | Currency | Desconto no troco |
Sale.paymentChange[0].paymentType | String | **Mesmo dos pagamentos - Sale.payments[0].paymentType |
Sale.paymentChange[0].paymentNumber | Integer | Número da forma de pagamento |
Sale.paymentChange[0].dateTimeIssue | DateTime | Data e hora do troco |
Sale.paymentChange[0].AuthorizationCode | String | Numero da autorização TEF |
Sale.paymentChange[0].TransactionCanceledCode | String | Numero da autorização cancelamento TEF |
Sale.paymentChange[0].TransactionCode | String | Número do NSU host |
Sale.paymentChange[0].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[0].price | Currency | Desconto do item |
Sale.Items[0].partitionDiscount[0].partnerCode | Integer | Código do parceiro que aplicou o desconto |
Sale.Items[0].partitionDiscount[0].promotionCode | Integer | Código de promoção |
Sale.Items[0].partitionDiscount[0].discountAmount | Integer | Quantidade do item |
Sale.Items[0].partitionIncrease | Array object Json | Lista de acréscimo dado no item |
Sale.Items[0].partitionIncrease[0].price | Currency | Desconto do item |
Sale.Items[0].partitionIncrease[0].partnerCode | Integer | Código do parceiro que aplicou o acréscimo |
Sale.Items[0].partitionIncrease[0].promotionCode | Integer | Código de promoção |
Sale.Items[0].partitionIncrease[0].discountAmount | Integer | Quantidade do item |
...
Bloco de código | ||
---|---|---|
| ||
{ "iD": "001001000000300", "version": 1, "sale": { "iD": "001001000000300", "increase": 0, "discount": 0, "total": 4.99, "header": { "idStore": 1, "idTerminal": 1, "idDocument": 300, "cooDocument": 126, "idUser": 1, "status": "sttValid", "idInvoiceKey": "35210100148007000155653210000002861181202417", "accountingDate": "2023-07-11", "dateTimeIssue": "2023-07-11", "identification": [{ "document": "12345678909", "partnerCode": 0, "documentType": "cdtCPF", "identificationType": "citInternal" }] }, "payments": [{ "expirationDateCard": "2023-07-11", "firstDigitCard": "123456", "flagCard": "1", "idWallet": "1", "increase": 0, "installmentAmount": 1, "itemNumber": 0, "lastDigitCard": "06", "networkCard": "123456", "ownerCard": "JOSE", "total": 4.99, "discount": 0, "paymentType": "cptMoney", "paymentNumber": 1, "authorizationCode": "123456789", "transactionCanceledCode": "123456789", "transactionCode": "123456", "typeWallet": "1", "dateTimeIssue": "2023-07-11", "partitionIncrease": [{ "price": 4.99, "partnerCode": 1, "promotionCode": 1, "discountAmount": 0 }] }], "paymentChange": { "expirationDateCard": "2023-07-11", "firstDigitCard": "123456", "flagCard": "1", "idWallet": "1", "increase": 0, "installmentAmount": 1, "itemNumber": 1, "lastDigitCard": "13", "networkCard": "123546", "ownerCard": "jose", "total": 4.99, "discount": 0, "paymentType": "cptMoney", "paymentNumber": 1, "authorizationCode": "123", "transactionCanceledCode": "1345689", "transactionCode": "1345689", "typeWallet": "1", "dateTimeIssue": "1899-12-30T00:00:00.000Z" }, "items": [{ "internalCode": "4900", "itemNumber": 1, "status": "sttValid", "unitPrice": 4.99, "increasePrice": 0, "captionPacking": "0", "packingQuantity": 1, "barCode": "7891000100103", "quantity": 1, "description": "LEITE MOCA", "totalPrice": 4.99, "discountPrice": 0, "sellerCode": 0, "idSegment": 3, "dateTimeIssue": "2023-07-11", "partitionDiscount": [{ "price": 4.99, "partnerCode": 1, "promotionCode": 1, "discountAmount": 0 }], "partitionIncrease": [{ "price": 4.99, "partnerCode": 1, "promotionCode": 1, "discountAmount": 0 }], "scale": false }] }, "event": "cetAfter", "operation": "cotEndSale", "execution": "cetContinue" } |
...