Statement
A statement groups all booked transactions and all other relevant payments on a monthly basis, unrelated to the payment frequency of the organization. It can be seen as an equivalent to a classic credit card statement.
Data model
Field | Type | Description |
---|---|---|
statementId | uuid | An identifier for the statement, unique to the company |
organizationId | uuid | An identifier for the organization that the statement belongs to; unique on the platform |
statementCreatedAt | date-time | Date & time when the statement was created by Pliant |
isClosed | boolean | Indicated if the statement is already closed. If set to true a statement PDF is available. Statements are closed on the second workday of the month following. |
statementPeriodStart | date-time | Start of the statement period |
statementPeriodEnd | date-time | End of the statement period |
openingBalance | object | An array in regard to the available amount for the current organization at the start of the statement period - value (decimal) - currency (string) |
closingBalance | object | An array in regard to the available amount for the current organization at the end of the statement period - value (decimal) - currency (string) |
totalTransactionAmount | object | An array in regard to the overall amount (sum) of all transactions that were booked within the statement period - value (decimal) - currency (string) |
totalPaymentAmount | object | An array in regard to the overall amount (sum) of all payments that were processed within the statement period - value (decimal) - currency (string) |
Example Data
[
{
"statementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"statementCreatedAt": "2022-04-01T11:02:55.866Z",
"isClosed": TRUE,
"statementPeriodStart": "2022-04-01T11:02:55.866Z",
"statementPeriodEnd": "2022-04-01T11:02:55.866Z",
"openingBalance": {
"value": 0,
"currency": "string"
},
"closingBalance": {
"value": 0,
"currency": "string"
},
"totalTransactionAmount": {
"value": 0,
"currency": "string"
},
"totalPaymentAmount": {
"value": 0,
"currency": "string"
}
}
]
State Machine
Updated 12 months ago