POST api/account/ledger

Retrive ledger postings without account id Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The get ledger items data contract supplied with the request.

GetLedgerItemsDataContract

Name	Description	Type	Additional information
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
TransactionType	The transaction type value.	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "StartDate": "2026-08-04T23:19:33.0815784Z",
  "EndDate": "2026-08-04T23:19:33.0815784Z",
  "TransactionType": "sample string 1"
}

Response Information

Resource Description

The response returned after the operation completes.

Collection of LedgerItemDataContract

Name	Description	Type	Additional information
Amount	The amount value.	decimal number	None.
Description	The description value.	string	None.
Balance	The balance value.	decimal number	None.
DrCr	The dr cr value.	string	None.
DateTime	The date time, expressed as a date and time.	date	None.
AccountId	The unique identifier of the related account resource.	integer	None.
AccountType	The account type value.	AccountingEnumDataContract	None.
TransactionType	The transaction type value.	AccountingEnumDataContract	None.
InvoiceSubType	The invoice sub type value.	AccountingEnumDataContract	None.
ClearedStatus	The cleared status value.	AccountingEnumDataContract	None.
LedgerEntryId	The unique identifier of the related ledger entry resource.	integer	None.
InvoiceId	The unique identifier of the related invoice resource.	integer	None.
RefundId	The unique identifier of the related refund resource.	integer	None.
IsCrPositive	Indicates whether this item is cr positive.	boolean	None.
FromTo	The from to value.	string	None.
FromToGroupId	The unique identifier of the related from to group resource.	integer	None.
From	The from value.	string	None.
FromGroupId	The unique identifier of the related from group resource.	integer	None.
To	The to value.	string	None.
ToGroupId	The unique identifier of the related to group resource.	integer	None.
IsAdjustment	Indicates whether this item is adjustment.	boolean	None.
IsReversal	Indicates whether this item is reversal.	boolean	None.
IsUnsuspended	Indicates whether this item is unsuspended.	boolean	None.
OriginalTotal	The original total value.	decimal number	None.
PaymentType	The payment type classification.	PaymentType	None.
IsReconciled	Indicates whether this item is reconciled.	boolean	None.
PaymentId	The unique identifier of the related payment resource.	integer	None.
PaymentItemId	The unique identifier of the related payment item resource.	integer	None.
PaymentReziDocumentIds	The unique identifiers of the related payment rezi document resources.	Collection of integer	None.
TenantRoleId	The unique identifier of the related tenant role resource.	integer	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
RelatedProperty	The related property value.	string	None.
IsInReversedPayment	Indicates whether this item is in reversed payment.	boolean	None.
IsProtected	Indicates whether this item is protected.	boolean	None.
IsReleased	Indicates whether this item is released.	boolean	None.
RefundedTotal	The refunded total value.	decimal number	None.
InvoiceAllocationsTotal	The invoice allocations total value.	decimal number	None.
Batch	The batch value.	LedgerLineBatchInfoDataContract	None.
CreatedById	The unique identifier of the related created by resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Amount": 1.0,
    "Description": "sample string 2",
    "Balance": 3.0,
    "DrCr": "sample string 4",
    "DateTime": "2026-08-04T23:19:33.0815784Z",
    "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-04T23:19:33.0815784Z",
    "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
  }
]