interbranch-accounts
Operations addressed under /interbranch-accounts — 3 operations.
get-interbranch-account-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<InterbranchAccountDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
LedgerCode | string | no |
Member names are the service's declaration names.
query Parameters
filterorderByorderSortpageIndexpageSizeget-interbranch-account-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.
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 |
currencyIdcurrencyTypePermitted 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 |
idledgerCodecreate-interbranch-account
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_117 | 400 | LEDGER_TYPE_CANNOT_BE_MAIN | 'Main' type ledgers cannot be used in accounting entries. |
ERR_ACCTNG_200 | 400 | CURRENCY_CANNOT_BE_SAME | It is not allowed to create more than one interbranch account with the same 'currencyId', 'currencyType' and 'currencyGroup'. |
ERR_ACCTNG_21 | 400 | LEDGER_MUST_BE_NOT_NULL | Ledger '{0}' is not found |
create-interbranch-account › 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.
update-interbranch-account
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_117 | 400 | LEDGER_TYPE_CANNOT_BE_MAIN | 'Main' type ledgers cannot be used in accounting entries. |
ERR_ACCTNG_200 | 400 | CURRENCY_CANNOT_BE_SAME | It is not allowed to create more than one interbranch account with the same 'currencyId', 'currencyType' and 'currencyGroup'. |
ERR_ACCTNG_201 | 400 | INTER_BRANCH_ACCOUNT_COULD_NOT_BE_FOUND | Interbranch account is not found with the given id: '{0}'. |
path Parameters
idupdate-interbranch-account › Request Body
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 |
currencyIdcurrencyTypePermitted 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 |
ledgerCodeupdate-interbranch-account › 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.