position-accounts
Operations addressed under /position-accounts — 6 operations.
create-position-account
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 AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
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_203 | 400 | LOCAL_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE | It is now allowed to have one than one position accounts with the same local Position Ledger:'{0}'. |
ERR_ACCTNG_205 | 400 | POSITION_CURRENCY_MUST_BE_UNIQUE | It is not allowed to create more than one position account with the same 'currencyId', 'currencyType' and 'currencyGroup'. |
ERR_ACCTNG_208 | 400 | FOREIGN_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE | It is now allowed to have one than one position accounts with the same foreign Position Ledger:'{0}'. |
ERR_ACCTNG_21 | 400 | LEDGER_MUST_BE_NOT_NULL | Ledger '{0}' is not found |
ERR_ACCTNG_239 | 400 | CURRENCY_NUMBER_IS_NOT_VALID | Currency is not found. |
create-position-account › Request Body
currencyGroupPermitted values — validated against the currency_group parameter.
| Value | Meaning |
|---|---|
1 | FX |
2 | PM |
Permitted 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.
| Value | Meaning |
|---|---|
1 | local |
2 | foreign |
3 | all |
Permitted 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 |
foreignPositionLedgerCodegainAccountLedgerCodelocalPositionLedgerCodelossAccountLedgerCodecreate-position-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.
get-position-account-by-currency-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
currencyIdget-position-account-by-currency-id › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
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 |
foreignPositionLedgerCodegainAccountLedgerCodeidlocalPositionLedgerCodelossAccountLedgerCodeget-position-account-by-currency-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 PositionAccountDto.
| Field | Declared type | Nullable |
|---|---|---|
CurrencyType | int? | yes |
CurrencyGroup | int? | yes |
CurrencyNumber | string | no |
ForeignPositionLedgerCode | string | no |
LocalPositionLedgerCode | string | no |
GainAccountLedgerCode | string | no |
LossAccountLedgerCode | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_207 | 400 | POSITION_ACCOUNT_BY_CURRENCY_ID_MUST_CONTAINS_A_SINGLE_VALUE | Position account is not found with the given currency Id: '{0}'. |
path Parameters
currencyNumberget-position-account-by-currency-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.
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 |
foreignPositionLedgerCodegainAccountLedgerCodeidlocalPositionLedgerCodelossAccountLedgerCodefx-position-revaluation
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
fx-position-revaluation › Request Body
exchangeRateTypeexchangeSpreadTypePermitted values — validated against the currency_rate_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | General | no label seeded |
2 | Special | no label seeded |
fx-position-revaluation › 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-position-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_203 | 400 | LOCAL_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE | It is now allowed to have one than one position accounts with the same local Position Ledger:'{0}'. |
ERR_ACCTNG_205 | 400 | POSITION_CURRENCY_MUST_BE_UNIQUE | It is not allowed to create more than one position account with the same 'currencyId', 'currencyType' and 'currencyGroup'. |
ERR_ACCTNG_206 | 400 | POSITION_ACCOUNT_MUST_EXITS | Position account is not found with given Id: '{0}'. |
ERR_ACCTNG_208 | 400 | FOREIGN_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE | It is now allowed to have one than one position accounts with the same foreign Position Ledger:'{0}'. |
ERR_ACCTNG_21 | 400 | LEDGER_MUST_BE_NOT_NULL | Ledger '{0}' is not found |
path Parameters
idupdate-position-account › Request Body
currencyGroupPermitted values — validated against the currency_group parameter.
| Value | Meaning |
|---|---|
1 | FX |
2 | PM |
Permitted 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.
| Value | Meaning |
|---|---|
1 | local |
2 | foreign |
3 | all |
Permitted 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 |
foreignPositionLedgerCodegainAccountLedgerCodelocalPositionLedgerCodelossAccountLedgerCodeupdate-position-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.
delete-position-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 |
|---|---|---|
ERR_ACCTNG_244 | 400 | POSITION_ACCOUNT_NOT_FOUND |
path Parameters
iddelete-position-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.