Skip to main content
GET
/
customers
/
{customerId}
/
invoicing-schedule
Get invoicing schedule
curl --request GET \
  --url https://api.example.com/customers/{customerId}/invoicing-schedule
{
  "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
      }
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Path Parameters

​
customerId
string
required

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

Response

​
data
object[]
required

Array invoice details

​
total
number

Optional: Total number of invoice details

​
offset
number

Optional: Number of invoice details the array has to star after

​
limit
number

Optional: Number of invoice details in the array