POST api/account/{id}/statement

Get a statement for an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The get statement data contract supplied with the request.

GetStatementDataContract

Name	Description	Type	Additional information
AccountIds	The unique identifiers of the related account resources.	Collection of integer	None.
StartDate	The start date, expressed as a date and time.	date	None.
ExplicitDate	The explicit date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
TransactionTypes	The collection of transaction types.	Collection of string	None.
ExcludedTypes	The collection of excluded types.	Collection of string	None.
Description	The description value.	string	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
ExcludeUncleared	Indicates whether exclude uncleared is true.	boolean	None.
ClearedStatuses	The collection of cleared statuses.	Collection of string	None.
DrOrCrSide	The dr or cr side value.	string	None.
PaymentTypes	The collection of payment types.	Collection of string	None.
AccountTypes	The collection of account types.	Collection of string	None.
IncludeReversals	Indicates whether include reversals is true.	boolean	None.
TenantRoleId	The unique identifier of the related tenant role resource.	integer	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
RelatedProperties	The collection of related properties.	Collection of string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AccountIds": [
    1,
    2
  ],
  "StartDate": "2026-08-06T02:06:03.6925111Z",
  "ExplicitDate": "2026-08-06T02:06:03.6925111Z",
  "EndDate": "2026-08-06T02:06:03.6925111Z",
  "TransactionTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludedTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Description": "sample string 1",
  "PageSize": 2,
  "PageNumber": 3,
  "ExcludeUncleared": true,
  "ClearedStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "DrOrCrSide": "sample string 4",
  "PaymentTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "AccountTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "IncludeReversals": true,
  "TenantRoleId": 1,
  "PropertyId": 1,
  "RelatedProperties": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

StatementDataContract

Name	Description	Type	Additional information
OpeningBalance	The opening balance value.	decimal number	None.
ClosingBalance	The closing balance value.	decimal number	None.
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
StatementType	The statement type value.	string	None.
Items	The collection of items.	Collection of LedgerItemDataContract	None.
RelatedProperties	The collection of related properties.	Collection of string	None.
Credits	The credits value.	decimal number	None.
Debits	The debits value.	decimal number	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
TotalCount	The total count value.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OpeningBalance": 1.0,
  "ClosingBalance": 2.0,
  "StartDate": "2026-08-06T02:06:03.6925111Z",
  "EndDate": "2026-08-06T02:06:03.6925111Z",
  "StatementType": "sample string 5",
  "Items": [
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2026-08-06T02:06:03.6925111Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "InvoiceSubType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "ClearedStatus": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "LedgerEntryId": 7,
      "InvoiceId": 1,
      "RefundId": 1,
      "IsCrPositive": true,
      "FromTo": "sample string 9",
      "FromToGroupId": 10,
      "From": "sample string 11",
      "FromGroupId": 12,
      "To": "sample string 13",
      "ToGroupId": 14,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 18.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "PaymentId": 20,
      "PaymentItemId": 1,
      "PaymentReziDocumentIds": [
        1,
        2
      ],
      "TenantRoleId": 1,
      "PropertyId": 1,
      "RelatedProperty": "sample string 21",
      "IsInReversedPayment": true,
      "IsProtected": true,
      "IsReleased": true,
      "RefundedTotal": 25.0,
      "InvoiceAllocationsTotal": 26.0,
      "Batch": {
        "IsProcessed": true,
        "Id": 2
      },
      "CreatedById": 27,
      "Id": 28
    },
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2026-08-06T02:06:03.6925111Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "InvoiceSubType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "ClearedStatus": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "LedgerEntryId": 7,
      "InvoiceId": 1,
      "RefundId": 1,
      "IsCrPositive": true,
      "FromTo": "sample string 9",
      "FromToGroupId": 10,
      "From": "sample string 11",
      "FromGroupId": 12,
      "To": "sample string 13",
      "ToGroupId": 14,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 18.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "PaymentId": 20,
      "PaymentItemId": 1,
      "PaymentReziDocumentIds": [
        1,
        2
      ],
      "TenantRoleId": 1,
      "PropertyId": 1,
      "RelatedProperty": "sample string 21",
      "IsInReversedPayment": true,
      "IsProtected": true,
      "IsReleased": true,
      "RefundedTotal": 25.0,
      "InvoiceAllocationsTotal": 26.0,
      "Batch": {
        "IsProcessed": true,
        "Id": 2
      },
      "CreatedById": 27,
      "Id": 28
    }
  ],
  "RelatedProperties": [
    "sample string 1",
    "sample string 2"
  ],
  "Credits": 6.0,
  "Debits": 7.0,
  "PageSize": 8,
  "PageNumber": 9,
  "TotalCount": 10
}