ledgers
Operations addressed under /ledgers — 8 operations.
get-ledger-list
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<LedgerDto>.
| Field | Declared type | Nullable |
|---|---|---|
LedgerCode | string | no |
Name | string | no |
Type | int? | yes |
LedgerLevel | int | no |
Status | int? | yes |
PassiveDate | DateTime? | yes |
MainCategory | int? | yes |
Category | int? | yes |
Character | int? | yes |
IsManualEntry | bool? | yes |
CustomerOption | int? | yes |
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
HasNegativeBalance | bool? | yes |
ParentLedgerCode | string | no |
PaddedLedgerCode | long | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_22 | 400 | END_LERGER_MUST_BE_BIGGER_BEGIN_LEDGER | 'ledgerCodeEnd' must be bigger than 'ledgerCodeBegin'. |
query Parameters
beginLedgerCodeledgerCodeBeginledgerCodeEndledgerCodeListledgerIdsorderByorderSortpageIndexpageSizeget-ledger-list › 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.
categoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
extendedPropertieshasNegativeBalanceidisManualEntryledgerCodeledgerLevelmainCategoryPermitted values — validated against the main_ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Expense | no label seeded |
2 | Income | no label seeded |
3 | BalanceSheet | no label seeded |
namepaddedLedgerCodepassiveDatestatusPermitted values — validated against the fiscal_year_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | closed | no label seeded |
1 | open | no label seeded |
2 | Permanently Closed | tr: Kalici olarak kapali |
typevalidFromvalidTocreate-ledger
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 CreateLedgerDto.
| Field | Declared type | Nullable |
|---|---|---|
LedgerCode | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_10 | 400 | LOWER_LEDGER_TYPE_MUST_BE_MAIN | Lower level ledger cannot be created if its higher level ledger's 'type' value is 'Sub'. |
ERR_ACCTNG_11 | 400 | LEDGER_LEVEL_LENGTH_MUST_BE_LEDGER_CODE_LENGTH | Length of the 'ledgerId' must be compatible with Ledger level. |
ERR_ACCTNG_14 | 400 | LEDGER_MUST_BE_NULL | Ledger already exists. LedgerCode: {0}. |
ERR_ACCTNG_15 | 400 | LEDGER_LEVEL_FORMAT_NOT_VALID | Ledger code must be compatible with the Ledger Level Format. |
ERR_ACCTNG_20 | 400 | PREVIOUS_LEDGER_MUST_BE_NOT_NULL | Previous ledger could not be found. |
ERR_ACCTNG_3 | 400 | LEDGER_LEVEL_MUST_BE_NOT_NULL | Ledger level not found. |
ERR_ACCTNG_9 | 400 | PREVIOUS_LEDGER_LEVEL_MUST_BE_NOT_NULL | Lower level ledger cannot be created withouth its higher level. LedgerCode: {0}. |
create-ledger › Request Body
ledgerCodeledgerLevelnametypecategoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
hasNegativeBalanceisManualEntrymainCategoryPermitted values — validated against the main_ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Expense | no label seeded |
2 | Income | no label seeded |
3 | BalanceSheet | no label seeded |
validFromvalidTocreate-ledger › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-ledger-by-ledger-code
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 LedgerDto.
| Field | Declared type | Nullable |
|---|---|---|
LedgerCode | string | no |
Name | string | no |
Type | int? | yes |
LedgerLevel | int | no |
Status | int? | yes |
PassiveDate | DateTime? | yes |
MainCategory | int? | yes |
Category | int? | yes |
Character | int? | yes |
IsManualEntry | bool? | yes |
CustomerOption | int? | yes |
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
HasNegativeBalance | bool? | yes |
ParentLedgerCode | string | no |
PaddedLedgerCode | long | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_21 | 400 | LEDGER_MUST_BE_NOT_NULL | Ledger '{0}' is not found |
path Parameters
ledgerCodeget-ledger-by-ledger-code › 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.
categoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
hasNegativeBalanceidisManualEntryledgerCodeledgerLevelmainCategoryPermitted values — validated against the main_ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Expense | no label seeded |
2 | Income | no label seeded |
3 | BalanceSheet | no label seeded |
namepaddedLedgerCodepassiveDatestatusPermitted values — validated against the fiscal_year_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | closed | no label seeded |
1 | open | no label seeded |
2 | Permanently Closed | tr: Kalici olarak kapali |
typedelete-ledger
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
ledgerCodedelete-ledger › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-ledger-by-id
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 LedgerDto.
| Field | Declared type | Nullable |
|---|---|---|
LedgerCode | string | no |
Name | string | no |
Type | int? | yes |
LedgerLevel | int | no |
Status | int? | yes |
PassiveDate | DateTime? | yes |
MainCategory | int? | yes |
Category | int? | yes |
Character | int? | yes |
IsManualEntry | bool? | yes |
CustomerOption | int? | yes |
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
HasNegativeBalance | bool? | yes |
ParentLedgerCode | string | no |
PaddedLedgerCode | long | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_26 | 400 | LEDGER_NOT_FOUND_BY_ID | Ledger is not found with the given id : '{0}'. |
path Parameters
idMERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. PUT takes the catalog field ledgerCode (string), while GET takes ledgerId (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.
get-ledger-by-id › 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.
categoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
extendedPropertieshasNegativeBalanceidisManualEntryledgerCodeledgerLevelmainCategoryPermitted values — validated against the main_ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Expense | no label seeded |
2 | Income | no label seeded |
3 | BalanceSheet | no label seeded |
namepaddedLedgerCodepassiveDatestatusPermitted values — validated against the fiscal_year_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | closed | no label seeded |
1 | open | no label seeded |
2 | Permanently Closed | tr: Kalici olarak kapali |
typevalidFromvalidToupdate-ledger
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_21 | 400 | LEDGER_MUST_BE_NOT_NULL | Ledger '{0}' is not found |
ERR_ACCTNG_29 | 400 | LEDGER_IS_USED_IN_ACCOUNTING_ENTRY_IT_CANNOT_BE_UPDATED | Ledger is used in accounting entry. It cannot be updated as 'Main'. |
ERR_ACCTNG_30 | 400 | MAIN_LEDGER_CANNOT_BE_UPDATED_SUB | 'Main' ledger {0} has lower ledgers. It cannot be updated as 'Sub'. |
path Parameters
idMERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. PUT takes the catalog field ledgerCode (string), while DELETE takes ledgerId (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.
MERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. PUT takes the catalog field ledgerCode (string), while GET takes ledgerId (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.
update-ledger › Request Body
ledgerLevelnametypecategoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
hasNegativeBalanceisManualEntrymainCategoryPermitted values — validated against the main_ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Expense | no label seeded |
2 | Income | no label seeded |
3 | BalanceSheet | no label seeded |
statusPermitted values — validated against the fiscal_year_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | closed | no label seeded |
1 | open | no label seeded |
2 | Permanently Closed | tr: Kalici olarak kapali |
validFromvalidToupdate-ledger › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
Delete Ledger
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-ledger-by-id service definition through DELETE /ledgers/{id}.
path Parameters
idMERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. PUT takes the catalog field ledgerCode (string), while DELETE takes ledgerId (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.
Delete Ledger › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-lower-ledger-list-by-ledger-code
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<LedgerDto>.
| Field | Declared type | Nullable |
|---|---|---|
LedgerCode | string | no |
Name | string | no |
Type | int? | yes |
LedgerLevel | int | no |
Status | int? | yes |
PassiveDate | DateTime? | yes |
MainCategory | int? | yes |
Category | int? | yes |
Character | int? | yes |
IsManualEntry | bool? | yes |
CustomerOption | int? | yes |
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
HasNegativeBalance | bool? | yes |
ParentLedgerCode | string | no |
PaddedLedgerCode | long | no |
Member names are the service's declaration names.
path Parameters
ledgerCodequery Parameters
orderByorderSortpageIndexpageSizeget-lower-ledger-list-by-ledger-code › 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.
categoryPermitted values — validated against the ledger_category parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | asset | no label seeded |
2 | liability | no label seeded |
3 | equity | no label seeded |
4 | revenue | no label seeded |
5 | expense | no label seeded |
6 | gains | no label seeded |
7 | lose | no label seeded |
8 | off_balance | no label seeded |
characterPermitted values — validated against the ledger_character parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Debit | no label seeded |
2 | Credit | no label seeded |
3 | Both | no label seeded |
currencyGroupPermitted values — validated against the currency_group parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | FX | no label seeded |
2 | PM | no label seeded |
currencyNumbercurrencyTypePermitted values — validated against the currency_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | local | no label seeded |
2 | foreign | no label seeded |
3 | all | no label seeded |
customerOptionPermitted values — validated against the ledger_customer_option parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | with_cus | no label seeded |
2 | without_cus | no label seeded |
3 | both | no label seeded |
hasNegativeBalanceidisManualEntryledgerCodeledgerLevelnamepaddedLedgerCodepassiveDatestatusPermitted values — validated against the fiscal_year_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | closed | no label seeded |
1 | open | no label seeded |
2 | Permanently Closed | tr: Kalici olarak kapali |
type