Skip to main content
GET
/
billing
{
  "data": [
    {
      "issuedAt": "<string>",
      "period": {
        "startedAt": "<string>",
        "endedAt": "<string>"
      },
      "components": [
        {
          "id": "<string>",
          "type": "PREMIUM",
          "premium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "reconciliation": true
        }
      ],
      "lines": [
        {
          "label": "<string>",
          "total": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          }
        }
      ],
      "total": {
        "amountPreFeesAndTaxes": 123,
        "fees": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123,
            "brokerageFirmId": "<string>"
          }
        ],
        "totalFees": 123,
        "amountWithFeesPreTaxes": 123,
        "taxes": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123
          }
        ],
        "totalTaxes": 123,
        "amountWithFeesAndTaxes": 123
      },
      "metadata": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "type": "INVOICE",
      "status": "DRAFTED",
      "createdAt": "<string>",
      "hasFailedOnce": true,
      "firstFailedAt": "<string>",
      "incrementalId": 123,
      "externalId": "<string>",
      "paymentId": "<string>",
      "paidAt": "<string>",
      "creditedInvoiceId": "<string>",
      "replacedInvoiceId": "<string>",
      "refundNotHandledReason": "SEPA_PAYMENT_180_DAYS_EXCEEDED"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Query Parameters

simulatedAt
string

Optional: the simulatedAt datetime

whenAt
string

Optional: the whenAt datetime

ids
string[]
required

the invoice ids to retrieve

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages