{
"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
}Returns a paginated list of invoices specified by their IDs. Supports simulation context via simulatedAt and whenAt query parameters.
{
"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
}Optional: the simulatedAt datetime
Optional: the whenAt datetime
the invoice ids to retrieve
the list of items in the page
Show child attributes
invoice issuance date
Show child attributes
PREMIUM, PERIL, FEE, TAX, SPECIAL Show child attributes
Show child attributes
Show child attributes
Show child attributes
the invoice id
entity type
INVOICE invoice status
DRAFTED, ISSUED, PAID, FINALIZED, PAYMENT_DISPUTED, PAYMENT_IN_PROGRESS, PAYMENT_FAILED, RECONCILED, CANCELLED, REFUND_NOT_HANDLED, PARTIALLY_FINALIZED, REFUND_IN_PROGRESS, WRITTEN_OFF invoice creation date
has invoice failed at least once
first invoice payment failure date
Incremental invoice id
External invoice id
Invoice payment id, if PAID
Payment date, if PAID
Original invoice that we are crediting
Original invoice that we are replacing
Reason for refund not handled
SEPA_PAYMENT_180_DAYS_EXCEEDED, INSUFFICIENT_AMOUNT the total number of items
the current page
the total number of pages
Was this page helpful?