Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Fatura

Busca as transações de uma fatura.

get/statements/transactions/{invoiceId}

Path parameters

invoiceIdinteger required

Id da Fatura

Query parameters

customerIdinteger

Id do Customer

pageSizeinteger

Parâmetros de paginação

pageOffsetinteger

Parâmetros de paginação (Inicia de 0)

orderinteger

Parâmetro de ordenação

eventDateStartinteger

Filtro de periodo inicial

eventDateEndinteger

Filtro de periodo final

Response

Ok

hasNextboolean

Example response

{
  "transactions": [
    {
      "softDescriptor": "string",
      "processingCode": "00",
      "processingDescription": "Purchase",
      "customerId": "dfcfdde-64bd-4a17-bbdf-3be627b2ard7",
      "userCategory": "SERVICES",
      "transactionGroup": "EXPENSES",
      "entryMode": "POS",
      "amount": [
        {
          "type": "PRINCIPAL",
          "currency": "string"
        }
      ],
      "tax": [
        {
          "type": "IOF"
        }
      ],
      "eventDate": "2022-08-24T19:15:24.000Z",
      "eventDatetime": "2022-08-24T19:15:24.000Z",
      "paymentDate": "2022-08-24T20:13:24.000Z",
      "paymentDatetime": "2022-08-24T20:13:24.000Z",
      "createdAt": "2022-08-24T19:05:24.000Z",
      "transactionType": {
        "description": "Credit voucher",
        "category": "PAYMENTS/CREDITS"
      },
      "card": {
        "name": "string"
      },
      "authorization": {
        "type": "PLATFORM",
        "code": "string",
        "paymentMethodId": "string",
        "network": "VISA",
        "trackingId": "string"
      },
      "merchant": {
        "id": "string",
        "type": "string",
        "name": "string",
        "city": "string",
        "state": "string",
        "category": {
          "code": "string",
          "description": "string",
          "groupName": "string",
          "networkGroup": "string"
        }
      }
    }
  ]
}