get
https://api.smartpos.app/v1/sales
Exibe todas as vendas que não foram excluídas
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Esta listagem exibe todas as vendas que não foram excluídas, filtradas conforme as condições especificadas. Somente as vendas marcadas como sucesso ("SUCCESS") ou canceladas apresentarão campos com links para o XML ("linkInvoiceSuccess" ou "linkInvoiceCanceled"). Apenas as vendas associadas a uma transação fiscal apresentarão campos fiscais, como número da fatura ("numberInvoice"), série da fatura ("seriesInvoice"), chave de acesso ("accessKey"), entre outros.
Exemplo de um retorno completo.
[
{
"id": "895",
"orderName": "Order #1234",
"creationDate": "2023-03-07T19:19:24.416Z",
"totalAmount": 7.0,
"discountAmount": 1.0,
"additionAmount": 2.0,
"statusNf": "SUCCESS",
"numberInvoice": 148533674,
"seriesInvoice": 64,
"linkInvoiceSuccess": "https://xml.smartpos.app/.../NFe35230365019499000124650640000000211809617374.xml",
"linkInvoiceCanceled": "https://xml.smartpos.app/.../NFe35230365019499000124650640000000211809617374.xml",
"isCanceled": false,
"dateTransferSefaz": "2023-03-07T19:22:22.000Z",
"cancellationDate": "2023-03-07T19:22:22.000Z",
"invoiceModel": 55,
"accessKey": "35190865019499000124550050000000511187183636",
"invoiceEnvironment": "HOMOLOGACAO",
"invoiceErrorCode": "210",
"invoiceErrorDetail": "Rejeição: IE do destinatário inválida",
"cancellationDetail": "Erro de sistema.",
"cancellationReason": "OTHERS",
"deviceId": "7ae9abba1f8a39b5",
"customer": {
"id": 123,
"type": "CLIENTE",
"personType": "FISICA",
"cpfCnpj": "12345678900",
"rgIe": "1234567",
"companyName": "Customer Company",
"fantasyName": "Customer Fantasia",
"im": 456,
"suframa": 789,
"isentoIcms": true,
"isSimples": false,
"observation": "Customer observations",
"email": "[email protected]",
"foneCallingCode": "+55",
"phone": "123456789",
"celularCallingCode": "+55",
"cellphone": "987654321",
"birthday": 19900101,
"limit": 1000.0,
"addresses": [
{
"addressType": "RESIDENCIAL",
"zipCode": "12345-678",
"streetType": "Rua",
"address": "Customer Street",
"number": "123",
"complement": "Apartment 456",
"district": "Customer District"
}
]
},
"seller": {
"name": "Seller Name",
"email": "[email protected]",
"phone": "987654321",
"commissionPercentage": 10.0
},
"isBudget": false,
"changeAmount": 1.0,
"profit": 2.0,
"freightType": "SEMFRETE",
"terminalType": "NFE",
"freightAmount": 1.0,
"netAmount": 1.0,
"commissionAmount": 1.0,
"customerDocument": "ABCD1234",
"receiptNumber": "RCT123456",
"protocolNumber": "123456789",
"applicationId": "app123",
"discountCoupon": {
"name": "Coupon Name",
"startDate": "2023-01-01T00:00:00.000Z",
"expirationDate": "2023-12-31",
"totalAmount": 50.0,
"isPercentDiscountApplied": true,
"minimumPurchaseAmount": 100.0,
"couponStatus": "OPENED",
"color": "Blue"
},
"discountCouponValue": 1.0,
"discountCouponPercent": 10.0,
"isTotemSale": false,
"processingFeeAmount": 0.5,
"queueNumber": 123,
"itemsIdentificationType": "PRODUCTS_AND_SERVICES",
"hasSignature": true,
"presencialInfo": {
"tableNumber": 5,
"customInformation": {
"answers": [
{
"key1": "value1"
},
{
"key2": "value2"
}
]
},
"isEventMode": false
},
"uniqueIdentifier": "unique123"
}
]
Descrição de todos os campos possíveis.
| Campo | Descrição |
|---|---|
| id (String) | Identificador único da venda, na tela de consulta vendas representado pelo campo código. |
| orderName (String) | Nome ou identificador associado ao pedido. |
| creationDate (Date) | Data e hora da criação da venda. |
| totalAmount (Double) | Valor total da venda. |
| discountAmount (Double) | Total do valor de desconto na venda. |
| additionAmount (Double) | Valor adicional adicionado ao valor total da venda. |
| statusNf (String) | Status da nota "SUCCESS", "PROCESSING", "ERROR". |
| numberInvoice (int) | Número da nota fiscal. |
| seriesInvoice (int) | Série da nota fiscal. |
| linkInvoiceSuccess (String) | Link para download do XML de sucesso da venda. Esse link é válido durante 15 dias e a cada nova chamada é gerado um link novo com a mesma validade de 15 dias. |
| linkInvoiceCanceled (String) | Link para download do XML de cancelamento da venda. Esse link é válido durante 15 dias e a cada nova chamada é gerado um link novo com a mesma validade de 15 dias. |
| isCanceled (boolean) | Indica se a venda foi cancelada ou não. |
| dateTransferSefaz (ZonedDateTime) | Data e hora em que a venda foi transferida para a SEFAZ. |
| cancellationDate (ZonedDateTime) | Data e hora em que a venda foi cancelada. |
| invoiceModel (int) | Modelo da Nota Fiscal (por exemplo, 55 para NF-e, 65 para NFC-e). |
| accessKey (String) | Chave de acesso associada à Nota Fiscal. |
| invoiceEnvironment (String) | Ambiente em que a Nota Fiscal foi emitida, podendo ser "HOMOLOGACAO" ou "PRODUCAO". |
| invoiceErrorCode (String) | Código de erro gerado durante o processo de envio da Nota Fiscal. |
| invoiceErrorDetail (String) | Detalhes sobre o erro na Nota Fiscal. |
| cancellationDetail (String) | Detalhes sobre o cancelamento da venda. |
| cancellationReason (String) | Motivo do cancelamento, opções incluem "STOCK", "PAYMENT", "OTHERS". |
| deviceId (String) | Id do dispositivo usado para realizar a venda. |
| uniqueIdentifier (String) | Identificador único associado à venda. |
| isBudget (boolean) | Indica se a venda é um orçamento ou não. |
| changeAmount (double) | Valor do troco dado durante a transação de venda. |
| profit (double) | Lucro obtido com a venda. |
| freightType (String) | Tipo de frete envolvido na venda, como "SEMFRETE", "EMITENTE", "DESTINATARIO", ou "TERCEIROS". |
| terminalType (String) | Categoria do terminal usado na venda, como "NFE", "NFCE", "CFE", "NAO_FISCAL". |
| freightAmount (double) | Valor cobrado pelo frete na venda. |
| netAmount (double) | Valor líquido total após descontos, acréscimos e deduções. |
| commissionAmount (double) | Valor da comissão incluída na venda. |
| customerDocument (String) | Documento identificador associado ao cliente. |
| receiptNumber (String) | Número do recibo gerado para a venda. |
| protocolNumber (String) | Representa o número de protocolo associado à venda. |
| applicationId (String) | Identificador da aplicação relacionada à venda. |
| discountCouponValue (double) | Valor do desconto aplicado usando o cupom. |
| discountCouponPercent (double) | Percentual de desconto aplicado usando o cupom. |
| isTotemSale (boolean) | Indica se a venda foi feita usando um totem. |
| processingFeeAmount (double) | Valor cobrado como taxa de processamento na venda. |
| queueNumber (int) | Número atribuído à venda em uma ordem de fila. |
| itemsIdentificationType (String) | Tipo de conteúdo na venda, como "PRODUCTS_AND_SERVICES", "ONLY_PRODUCTS", "ONLY_SERVICES". |
| hasSignature (boolean) | Indica se a venda tem uma assinatura. |
| --- | --- |
| customer (Object) | Detalhes sobre o cliente associado à venda. Inclui: |
| id (int) | Identificador único do cliente. |
| type (String) | Tipo de cliente (por exemplo, "CLIENTE", "FORNECEDOR", "TRANSPORTADORA"). |
| personType (String) | Tipo de pessoa (por exemplo, "FISICA" para pessoa física, "JURIDICA" para pessoa jurídica). |
| cpfCnpj (String) | CPF (para pessoas físicas) ou CNPJ (para empresas) do cliente. |
| rgIe (String) | RG (para pessoas físicas) ou IE (para empresas) do cliente. |
| companyName (String) | Nome da empresa (se aplicável). |
| fantasyName (String) | Nome fantasia do cliente. |
| im (long) | Inscrição Municipal do cliente. |
| suframa (int) | Registro SUFRAMA do cliente. |
| isentoIcms (boolean) | Indica se o cliente está isento de ICMS. |
| isSimples (boolean) | Indica se o cliente está no regime tributário do Simples Nacional. |
| observation (String) | Observações adicionais relacionadas ao cliente. |
| email (String) | Endereço de e-mail do cliente. |
| foneCallingCode (String) | Código de discagem para o número de telefone do cliente. |
| phone (String) | Número de telefone do cliente. |
| celularCallingCode (String) | Código de discagem para o número de celular do cliente. |
| cellphone (String) | Número de celular do cliente. |
| birthday (int) | Data de aniversário do cliente. |
| limit (double) | Limite de compra para o cliente. |
| addresses (Object) | Lista de endereços associados ao cliente, incluindo: |
| addressType (String) | Tipo de endereço (por exemplo, "RESIDENCIAL", "COMERCIAL", "OUTROS"). |
| zipCode (String) | CEP do endereço. |
| streetType (String) | Tipo de rua. |
| address (String) | Endereço. |
| number (String) | Número da casa ou prédio. |
| complement (String) | Informações adicionais sobre o endereço. |
| district (String) | Bairro do endereço. |
| --- | --- |
| seller (Object) | Detalhes sobre o vendedor associado à venda. Inclui: |
| name (String) | Nome do vendedor. |
| email (String) | Endereço de e-mail do vendedor. |
| phone (String) | Número de telefone do vendedor. |
| commissionPercentage (Double) | Percentual de comissão para o vendedor. |
| --- | --- |
| discountCoupon (Object) | Detalhes sobre o cupom de desconto usado na venda. Inclui: |
| name (String) | Nome do cupom. |
| startDate (Date) | Data de início de validade do cupom. |
| expirationDate (LocalDate) | Data de validade do cupom. |
| totalAmount (Double) | Valor total associado ao cupom. |
| isPercentDiscountApplied (boolean) | Indica se o desconto aplicado é percentual. |
| minimumPurchaseAmount (Double) | Valor mínimo de compra necessário para usar o cupom. |
| couponStatus (String) | Status do cupom (por exemplo, "OPENED", "BLOCKED"). |
| color (String) | Cor associada ao cupom. |
| --- | --- |
| presencialInfo (Object) | Informações sobre a venda em um ambiente físico. Inclui: |
| tableNumber (int) | Número da mesa onde a venda ocorreu. |
| customInformation (Object) | Informações personalizadas relacionadas à venda. |
| isEventMode (boolean) | Indica se a venda está no modo de evento. |