POST api/account/statement/csv
Get a statement for an account
Request Information
URI Parameters
None.
Body Parameters
Dezrez.Core.DataContracts.External.Api.Lists.Accounting.Filter.TransactionListFilterDataContractName | Description | Type | Additional information |
---|---|---|---|
AccountId | integer |
None. |
|
AccountIds | Collection of integer |
None. |
|
StartDate | date |
None. |
|
ExplicitDate | date |
None. |
|
EndDate | date |
None. |
|
TransactionTypes | Collection of string |
None. |
|
RelatedProperties | Collection of string |
None. |
|
ExcludedTypes | Collection of string |
None. |
|
Description | string |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
ExcludeUncleared | boolean |
None. |
|
ClearedStatuses | Collection of string |
None. |
|
DrOrCrSide | string |
None. |
|
PaymentTypes | Collection of string |
None. |
|
AccountTypes | Collection of string |
None. |
|
IncludeReversals | boolean |
None. |
|
TenantRoleId | integer |
None. |
|
PropertyId | integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "AccountId": 1, "AccountIds": [ 1, 2 ], "StartDate": "2024-10-08T09:00:46.8778653Z", "ExplicitDate": "2024-10-08T09:00:46.8778653Z", "EndDate": "2024-10-08T09:00:46.8778653Z", "TransactionTypes": [ "sample string 1", "sample string 2" ], "RelatedProperties": [ "sample string 1", "sample string 2" ], "ExcludedTypes": [ "sample string 1", "sample string 2" ], "Description": "sample string 2", "PageSize": 3, "PageNumber": 4, "ExcludeUncleared": true, "ClearedStatuses": [ "sample string 1", "sample string 2" ], "DrOrCrSide": "sample string 5", "PaymentTypes": [ "sample string 1", "sample string 2" ], "AccountTypes": [ "sample string 1", "sample string 2" ], "IncludeReversals": true, "TenantRoleId": 1, "PropertyId": 1 }
Response Information
Resource Description
Dezrez.Core.DataContracts.Accounts.Financial.Query.Statement.StatementDataContractName | Description | Type | Additional information |
---|---|---|---|
OpeningBalance | decimal number |
None. |
|
ClosingBalance | decimal number |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
StatementType | string |
None. |
|
Items | Collection of Dezrez.Core.DataContracts.Accounts.Financial.Query.Ledger.LedgerItemDataContract |
None. |
|
RelatedProperties | Collection of string |
None. |
|
Credits | decimal number |
None. |
|
Debits | decimal number |
None. |
|
PageSize | integer |
None. |
|
PageNumber | integer |
None. |
|
TotalCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "OpeningBalance": 1.0, "ClosingBalance": 2.0, "StartDate": "2024-10-08T09:00:46.8934918Z", "EndDate": "2024-10-08T09:00:46.8934918Z", "StatementType": "sample string 5", "Items": [ { "Amount": 1.0, "Description": "sample string 2", "Balance": 3.0, "DrCr": "sample string 4", "DateTime": "2024-10-08T09:00:46.8934918Z", "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, "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": "2024-10-08T09:00:46.8934918Z", "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, "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 }