ledger-balances
Operations addressed under /ledger-balances — 2 operations.
get-ledger-balance-by-account-number
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as LedgerBalanceDto.
| Field | Declared type | Nullable |
|---|---|---|
BalanceDate | DateOnly | no |
Ledgers | List<LedgerItem> (collection) | no |
Member names are the service's declaration names.
path Parameters
accountNumberquery Parameters
balanceDateget-ledger-balance-by-account-number › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
balanceDateget-ledger-balance-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<LedgerBalanceDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
TransactionDate | DateOnly | no |
LedgerCode | string | no |
LedgerName | string | no |
AccountNumber | string | no |
CurrencyNumber | string | no |
CurrencyCode | string | no |
OrganizationCode | string | no |
Description | string | no |
BalanceType | int | no |
DebitAmount | decimal | no |
CreditAmount | decimal | no |
DebitBalance | decimal | no |
CreditBalance | decimal | no |
AccountingEntryId | Guid? | yes |
ReversalAccountingEntryId | Guid? | yes |
FinancialTransactionCode | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_175 | 400 | END_DATE_MUST_BE_BIGGER_BEGIN_DATE | 'endDate' must be bigger than 'beginDate'. |
ERR_ACCTNG_190 | 400 | DATE_CANNOT_BE_GREATER_THAN_TODAY | It is not allowed to query a future dated balance. |
query Parameters
accountNumberbeginDateendDateledgerCodeBeginledgerCodeEndledgerCodeListorderByorderSortorganizationCodepageIndexpageSizewithPreviousBalanceget-ledger-balance-detail › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountNumberaccountingEntryIdbalanceTypecreditAmountcreditBalancecurrencyCodecurrencyNumberdebitAmountdebitBalancedescriptionfinancialTransactionCodeledgerCodeledgerNameorganizationCodereversalAccountingEntryIdtransactionDate