account-products
Operations addressed under /account-products — 32 operations.
create-account-product
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_1 | 400 | THERE_IS_A_DEFINITION_WITH_THE_SAME_CODE | There is a definition with the same code. |
ERR_ACCNT_3 | 400 | PARENT_ID_IS_NOT_FOUND | Parent product not found. |
ERR_ACCNT_4 | 400 | PARENT_PRODUCT_IS_NOT_ACTIVE | Parent product is not active. |
create-account-product › Request Body
codenameaccountProductTypePermitted values — validated against the account_product_type parameter.
| Value | Meaning |
|---|---|
1 | Current |
2 | Participation |
3 | Credit |
4 | Daily Time Deposit |
5 | Virtual |
6 | Seller Payment Account |
balanceControlEndTimebalanceControlStartTimecontributionCalculateTypePermitted values — validated against the contribution_calculate_type parameter.
| Value | Meaning |
|---|---|
1 | Basic |
2 | Compound |
descriptionextensionDayextensionTypePermitted values — validated against the extension_type parameter.
| Value | Meaning |
|---|---|
1 | Maturity |
hasMaturityinterimContributionPaymentisAutoRenewalisDepositedisDirectMoneyOutflowisInterimContributionPaymentisMaturityToFirstWorkdayisRegularPaymentMandatoryisSpecialRateAvailableisWithdrawnmaxSpecialRateminSpecialRateminimumMaturityForPenaltyFreeWithdrawalparentAccountProductIdregularDepositPeriodicityvalueDayvalueStartDayPermitted values — validated against the value_start_day parameter.
| Value | Meaning |
|---|---|
1 | Workday |
2 | Day |
create-account-product › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
update-account-product
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_ACCNT_139 | 400 | PARENT_ID_CANNOT_BE_SAME_AS_PRODUCT_ID | The account product cannot be a parent. |
ERR_ACCNT_71 | 400 | IS_ACTIVE_MUST_NOT_BE_EMPTY | Is Active must not be empty. |
path Parameters
idupdate-account-product › Request Body
isActivenameaccountProductTypePermitted values — validated against the account_product_type parameter.
| Value | Meaning |
|---|---|
1 | Current |
2 | Participation |
3 | Credit |
4 | Daily Time Deposit |
5 | Virtual |
6 | Seller Payment Account |
balanceControlEndTimebalanceControlStartTimecontributionCalculateTypePermitted values — validated against the contribution_calculate_type parameter.
| Value | Meaning |
|---|---|
1 | Basic |
2 | Compound |
descriptionextensionDayextensionTypePermitted values — validated against the extension_type parameter.
| Value | Meaning |
|---|---|
1 | Maturity |
hasMaturityinterimContributionPaymentisAutoRenewalisDepositedisDirectMoneyOutflowisInterimContributionPaymentisMaturityToFirstWorkdayisRegularPaymentMandatoryisSpecialRateAvailableisWithdrawnmaxSpecialRateminSpecialRateminimumMaturityForPenaltyFreeWithdrawalparentAccountProductIdregularDepositPeriodicityvalueDayvalueStartDayPermitted values — validated against the value_start_day parameter.
| Value | Meaning |
|---|---|
1 | Workday |
2 | Day |
update-account-product › 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-account-product
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_ACCNT_10 | 400 | RECORD_CANNOT_BE_DELETED_IT_IS_PARENT_OF_ANOTHER_PRODUCT_DEFINITION | This record cannot be deleted because it is defined as a parent on another product definition. First delete child products. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_91 | 400 | ACCOUNT_ITEM_IS_USED | Account Product is used. |
path Parameters
iddelete-account-product › 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-blockable-rate-by-account-product-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
get-blockable-rate-by-account-product-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
create-account-product-config
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_9 | 400 | DUBLICATE_CUSTOMER_TYPE_FOR_THIS_ACCOUNT_PRODUCT | Dublicate customer type for this account product. |
path Parameters
idcreate-account-product-config › Request Body
customerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
create-account-product-config › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-product-config-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 AccountProductConfigDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CustomerType | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_8 | 400 | ACCOUNT_PRODUCT_CONFIGS_NOT_FOUND | Account Product Details not found. |
path Parameters
idconfigIdget-account-product-config-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.
customerTypeidupdate-account-product-config
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_8 | 400 | ACCOUNT_PRODUCT_CONFIGS_NOT_FOUND | Account Product Details not found. |
ERR_ACCNT_9 | 400 | DUBLICATE_CUSTOMER_TYPE_FOR_THIS_ACCOUNT_PRODUCT | Dublicate customer type for this account product. |
path Parameters
idconfigIdupdate-account-product-config › Request Body
customerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
update-account-product-config › 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-account-product-config
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_8 | 400 | ACCOUNT_PRODUCT_CONFIGS_NOT_FOUND | Account Product Details not found. |
path Parameters
idconfigIddelete-account-product-config › 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.
create-account-product-contribution
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
path Parameters
idcreate-account-product-contribution › Request Body
beginDatecontributionRatecurrencyNumberendDatematurityUnitmaxAmountmaxBalancemaxMaturityminAmountminBalanceminMaturitycreate-account-product-contribution › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-product-tax-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<AccountProductTaxDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductTaxesId | Guid | no |
AccountProductContributionId | Guid | no |
TaxId | Guid? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
path Parameters
idaccountProductContributionIdquery Parameters
isActiveorderByorderSortpageIndexpageSizetaxIdget-account-product-tax-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.
accountProductContributionIdaccountProductTaxesIdidisActivetaxIdcreate-account-product-tax
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
ERR_ACCNT_95 | 400 | TAX_NOT_FOUND | tax not found. |
path Parameters
idaccountProductContributionIdcreate-account-product-tax › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-product-tax-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 AccountProductTaxDto.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductTaxesId | Guid | no |
AccountProductContributionId | Guid | no |
TaxId | Guid? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
ERR_ACCNT_94 | 400 | ACCOUNT_PRODUCT_TAX_NOT_FOUND | Account product tax not found. |
path Parameters
idaccountProductContributionIdaccountProductTaxIdget-account-product-tax-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.
accountProductContributionIdaccountProductTaxesIdidisActivetaxIdupdate-account-product-tax
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
ERR_ACCNT_94 | 400 | ACCOUNT_PRODUCT_TAX_NOT_FOUND | Account product tax not found. |
ERR_ACCNT_95 | 400 | TAX_NOT_FOUND | tax not found. |
path Parameters
idaccountProductContributionIdaccountProductTaxIdupdate-account-product-tax › 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-account-product-tax
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
ERR_ACCNT_94 | 400 | ACCOUNT_PRODUCT_TAX_NOT_FOUND | Account product tax not found. |
path Parameters
idaccountProductContributionIdaccountProductTaxIddelete-account-product-tax › 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-account-product-transaction-limit-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<AccountProductTransactionLimitDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductContributionId | Guid | no |
Id | Guid | no |
CashTransactionType | int | no |
MinAmount | decimal? | yes |
MaxAmount | decimal? | yes |
MinRate | decimal? | yes |
MaxRate | decimal? | yes |
Member names are the service's declaration names.
path Parameters
idaccountProductContributionIdquery Parameters
orderByorderSortpageIndexpageSizeget-account-product-transaction-limit-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.
accountProductContributionIdcashTransactionTypeidmaxAmountmaxRateminAmountminRatecreate-account-product-transaction-limit
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_122 | 400 | TRANSACTION_LIMIT_ALREADY_DEFINED_FOR_THIS_TYPE | Transaction limit already defined for this type. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idaccountProductContributionIdcreate-account-product-transaction-limit › Request Body
cashTransactionTypePermitted values — validated against the cash_transaction_type parameter.
| Value | Meaning |
|---|---|
1 | para_yatırma |
2 | para_cekme |
3 | virman |
4 | havale |
maxAmountmaxRateminAmountminRatecreate-account-product-transaction-limit › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-product-transaction-limit-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 AccountProductTransactionLimitDto.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductContributionId | Guid | no |
Id | Guid | no |
CashTransactionType | int | no |
MinAmount | decimal? | yes |
MaxAmount | decimal? | yes |
MinRate | decimal? | yes |
MaxRate | decimal? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_106 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_TRANSACTION_LIMIT_NOT_FOUND | Account product contribution transaction limit not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idaccountProductContributionIdtransactionLimitIdget-account-product-transaction-limit-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.
accountProductContributionIdcashTransactionTypeidmaxAmountmaxRateminAmountminRateupdate-account-product-transaction-limit
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_ACCNT_106 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_TRANSACTION_LIMIT_NOT_FOUND | Account product contribution transaction limit not found. |
ERR_ACCNT_122 | 400 | TRANSACTION_LIMIT_ALREADY_DEFINED_FOR_THIS_TYPE | Transaction limit already defined for this type. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idaccountProductContributionIdtransactionLimitIdupdate-account-product-transaction-limit › Request Body
cashTransactionTypePermitted values — validated against the cash_transaction_type parameter.
| Value | Meaning |
|---|---|
1 | para_yatırma |
2 | para_cekme |
3 | virman |
4 | havale |
maxAmountmaxRateminAmountminRateupdate-account-product-transaction-limit › 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-account-product-transaction-limit
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_ACCNT_106 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_TRANSACTION_LIMIT_NOT_FOUND | Account product contribution transaction limit not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idaccountProductContributionIdtransactionLimitIddelete-account-product-transaction-limit › 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-account-product-contribution-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 AccountProductContributionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
AccountProductId | Guid | no |
CurrencyNumber | string | no |
CurrencyCode | string | no |
MinAmount | decimal? | yes |
MaxAmount | decimal? | yes |
MinMaturity | int? | yes |
MaxMaturity | int? | yes |
MaturityUnit | int? | yes |
ContributionRate | decimal? | yes |
MinBalance | decimal? | yes |
MaxBalance | decimal? | yes |
BeginDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
PoolDefinitionId | Guid? | yes |
PoolDefinitionRateId | Guid? | yes |
AccountProductTaxes | List<AccountProductTaxDto> (collection) | no |
AccountProductTransactionLimits | List<AccountProductTransactionLimitDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idcontributionIdget-account-product-contribution-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.
accountProductIdbeginDatecontributionRatecurrencyCodecurrencyNumberendDateidmaturityUnitmaxAmountmaxBalancemaxMaturityminAmountminBalanceminMaturityupdate-account-product-contribution
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idcontributionIdupdate-account-product-contribution › Request Body
beginDatecontributionRatecurrencyNumberendDatematurityUnitmaxAmountmaxBalancemaxMaturityminAmountminBalanceminMaturityupdate-account-product-contribution › 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-account-product-contribution
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_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
ERR_ACCNT_93 | 400 | ACCOUNT_PRODUCT_CONTRIBUTION_NOT_FOUND | Account product contribution not found. |
path Parameters
idcontributionIddelete-account-product-contribution › 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-account-product-convertible-currency-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<AccountProductConvertibleCurrencyDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductId | Guid | no |
Id | Guid | no |
ExchangeSpreadType | int? | yes |
CurrencyCode | string | no |
CurrencyNumber | string | no |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-account-product-convertible-currency-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.
accountProductIdcurrencyCodecurrencyNumberexchangeSpreadTypecreate-account-product-convertible-currency
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_104 | 400 | DUPLICATE_COVERTIBLE_CURRENCY_FOR_THIS_ACCOUNT_PRODUCT | Duplicate convertible currency for this account product. |
ERR_ACCNT_18 | 400 | CURRENCY_ID_NOT_FOUND | Currency not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
path Parameters
idcreate-account-product-convertible-currency › Request Body
currencyNumberexchangeSpreadTypePermitted values — validated against the exchange_spread_type parameter.
| Value | Meaning |
|---|---|
1 | Purchase Rate to Customer |
2 | Sales Rate to Customer |
create-account-product-convertible-currency › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-account-product-convertible-currency-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 AccountProductConvertibleCurrencyDto.
| Field | Declared type | Nullable |
|---|---|---|
AccountProductId | Guid | no |
Id | Guid | no |
ExchangeSpreadType | int? | yes |
CurrencyCode | string | no |
CurrencyNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_105 | 400 | ACCOUUNT_PRODUCT_CONVERTIBLE_CURRENCY_NOT_FOUND | Account product convertible currency not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
path Parameters
idconvertibleCurrencyIdget-account-product-convertible-currency-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.
accountProductIdcurrencyCodecurrencyNumberexchangeSpreadTypeidupdate-account-product-convertible-currency
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_ACCNT_104 | 400 | DUPLICATE_COVERTIBLE_CURRENCY_FOR_THIS_ACCOUNT_PRODUCT | Duplicate convertible currency for this account product. |
ERR_ACCNT_105 | 400 | ACCOUUNT_PRODUCT_CONVERTIBLE_CURRENCY_NOT_FOUND | Account product convertible currency not found. |
ERR_ACCNT_18 | 400 | CURRENCY_ID_NOT_FOUND | Currency not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
path Parameters
idconvertibleCurrencyIdupdate-account-product-convertible-currency › Request Body
currencyNumberexchangeSpreadTypePermitted values — validated against the exchange_spread_type parameter.
| Value | Meaning |
|---|---|
1 | Purchase Rate to Customer |
2 | Sales Rate to Customer |
update-account-product-convertible-currency › 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-account-product-convertible-currency
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_ACCNT_105 | 400 | ACCOUUNT_PRODUCT_CONVERTIBLE_CURRENCY_NOT_FOUND | Account product convertible currency not found. |
ERR_ACCNT_7 | 400 | ACCOUNT_PRODUCT_NOT_FOUND | Account product not found. |
path Parameters
idconvertibleCurrencyIddelete-account-product-convertible-currency › 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-account-product-exception
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idget-account-product-exception › 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.
accountProductIdidisActiveratecreate-account-product-exception
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-account-product-exception › 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 |
idupdate-account-product-exception
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
exceptionIdPresent in the route template but not declared as a Route-bound field in the catalog.
update-account-product-exception › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
delete-account-product-exception
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
exceptionIdPresent in the route template but not declared as a Route-bound field in the catalog.
delete-account-product-exception › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
is-account-product-usaged
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Message |
|---|---|---|
ERR_ACCNT_7 | 400 | Account product not found. |
path Parameters
idis-account-product-usaged › 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.