POST api/account/{id}/statement

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

GetStatementDataContract
NameDescriptionTypeAdditional information
AccountId

integer

None.

AccountIds

Collection of integer

None.

StartDate

date

None.

ExplicitDate

date

None.

EndDate

date

None.

TransactionTypes

Collection of LedgerType

None.

ExcludedTypes

Collection of LedgerType

None.

Description

string

None.

PageSize

integer

None.

PageNumber

integer

None.

ExcludeUncleared

boolean

None.

ClearedStatuses

Collection of ClearedStatus

None.

DrOrCrSide

DrOrCrSide

None.

PaymentTypes

Collection of PaymentType

None.

AccountTypes

Collection of AccountType

None.

IncludeReversals

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountId": 1,
  "AccountIds": [
    1,
    2
  ],
  "StartDate": "2019-03-24T09:10:31.3570359Z",
  "ExplicitDate": "2019-03-24T09:10:31.3570359Z",
  "EndDate": "2019-03-24T09:10:31.3570359Z",
  "TransactionTypes": [
    1,
    1
  ],
  "ExcludedTypes": [
    1,
    1
  ],
  "Description": "sample string 2",
  "PageSize": 3,
  "PageNumber": 4,
  "ExcludeUncleared": true,
  "ClearedStatuses": [
    0,
    0
  ],
  "DrOrCrSide": 0,
  "PaymentTypes": [
    0,
    0
  ],
  "AccountTypes": [
    0,
    0
  ],
  "IncludeReversals": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetStatementDataContract'.

Response Information

Resource Description

StatementDataContract
NameDescriptionTypeAdditional information
OpeningBalance

decimal number

None.

ClosingBalance

decimal number

None.

StartDate

date

None.

EndDate

date

None.

StatementType

string

None.

Items

Collection of LedgerItemDataContract

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": "2019-03-24T09:10:31.421599Z",
  "EndDate": "2019-03-24T09:10:31.421599Z",
  "StatementType": "sample string 5",
  "Items": [
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2019-03-24T09:10:31.421599Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TranscationType": {
        "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,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 14.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "Id": 16
    },
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2019-03-24T09:10:31.421599Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TranscationType": {
        "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,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 14.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "Id": 16
    }
  ],
  "Credits": 6.0,
  "Debits": 7.0,
  "PageSize": 8,
  "PageNumber": 9,
  "TotalCount": 10
}