products
Operations addressed under /products — 13 operations.
get-accrual-product-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<AccrualProductAndFieldsDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccrualProductFields | List<AccrualProductFieldDto> (collection) | no |
AccrualProductFormulas | List<AccrualProductFormulaDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-accrual-product-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.
accountProductIdaccountingEntryProcessTypePermitted values — validated against the acc_entry_process_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Mass | no label seeded |
2 | Single | no label seeded |
accrualCalculationPeriodPermitted values — validated against the calculation_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Daily | no label seeded |
2 | Weekly | no label seeded |
3 | Monthly | no label seeded |
4 | Querterly | no label seeded |
5 | Semiannually | no label seeded |
6 | Annually | no label seeded |
dateBasisPermitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | 30/360 | no label seeded |
2 | 30/365 | no label seeded |
3 | Actual/360 | no label seeded |
4 | Actual/365 | no label seeded |
5 | Actual/Actual | no label seeded |
idisCalculationPeriodicalnametypePermitted values — validated against the accrual_product_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Loan | no label seeded |
2 | Bond | no label seeded |
3 | Bill | no label seeded |
4 | Expense | no label seeded |
create-accrual-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 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_ACCRL_1 | 400 | ACCRUAL_PRODUCT_MUST_BE_NULL | It is not allowed to create more than one product with the same Domain, Product: {0}. |
ERR_ACCRL_21 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION | Product has to have a formula for periodical calculation, early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_22 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION_EARLYPAYMENT_AND_EARLY_CALCULATION | It is not allowed to have more than formula for early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_3 | 400 | FIELD_NAME_MUST_BE_UNIQUE_FOR_EACH_PRODUCT | It is not allowed to create more than one field with same name for a product. |
create-accrual-product › Request Body
accountProductIdaccountingEntryProcessTypePermitted values — validated against the acc_entry_process_type parameter.
| Value | Meaning |
|---|---|
1 | Mass |
2 | Single |
Permitted values — validated against the acc_entry_process_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Mass | no label seeded |
2 | Single | no label seeded |
dateBasisPermitted values — validated against the date_difference parameter.
| Value | Meaning |
|---|---|
1 | 30/360 |
2 | 30/365 |
3 | Actual/360 |
4 | Actual/365 |
5 | Actual/Actual |
Permitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | 30/360 | no label seeded |
2 | 30/365 | no label seeded |
3 | Actual/360 | no label seeded |
4 | Actual/365 | no label seeded |
5 | Actual/Actual | no label seeded |
isCalculationPeriodicalnametypePermitted values — validated against the accrual_product_type parameter.
| Value | Meaning |
|---|---|
1 | Loan |
2 | Bond |
3 | Bill |
4 | Expense |
Permitted values — validated against the accrual_product_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Loan | no label seeded |
2 | Bond | no label seeded |
3 | Bill | no label seeded |
4 | Expense | no label seeded |
accrualCalculationPeriodPermitted values — validated against the calculation_period parameter.
| Value | Meaning |
|---|---|
1 | Daily |
2 | Weekly |
3 | Monthly |
4 | Querterly |
5 | Semiannually |
6 | Annually |
Permitted values — validated against the calculation_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Daily | no label seeded |
2 | Weekly | no label seeded |
3 | Monthly | no label seeded |
4 | Querterly | no label seeded |
5 | Semiannually | no label seeded |
6 | Annually | no label seeded |
create-accrual-product › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-accrual-product-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 AccrualProductAndFieldsDto.
| Field | Declared type | Nullable |
|---|---|---|
AccrualProductFields | List<AccrualProductFieldDto> (collection) | no |
AccrualProductFormulas | List<AccrualProductFormulaDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
path Parameters
idget-accrual-product-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.
accountProductIdaccountingEntryProcessTypePermitted values — validated against the acc_entry_process_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Mass | no label seeded |
2 | Single | no label seeded |
accrualCalculationPeriodPermitted values — validated against the calculation_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Daily | no label seeded |
2 | Weekly | no label seeded |
3 | Monthly | no label seeded |
4 | Querterly | no label seeded |
5 | Semiannually | no label seeded |
6 | Annually | no label seeded |
dateBasisPermitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | 30/360 | no label seeded |
2 | 30/365 | no label seeded |
3 | Actual/360 | no label seeded |
4 | Actual/365 | no label seeded |
5 | Actual/Actual | no label seeded |
idisCalculationPeriodicalnametypePermitted values — validated against the accrual_product_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Loan | no label seeded |
2 | Bond | no label seeded |
3 | Bill | no label seeded |
4 | Expense | no label seeded |
update-accrual-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_ACCRL_1 | 400 | ACCRUAL_PRODUCT_MUST_BE_NULL | It is not allowed to create more than one product with the same Domain, Product: {0}. |
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
path Parameters
idupdate-accrual-product › Request Body
accountProductIdaccountingEntryProcessTypePermitted values — validated against the acc_entry_process_type parameter.
| Value | Meaning |
|---|---|
1 | Mass |
2 | Single |
Permitted values — validated against the acc_entry_process_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Mass | no label seeded |
2 | Single | no label seeded |
accrualCalculationPeriodPermitted values — validated against the calculation_period parameter.
| Value | Meaning |
|---|---|
1 | Daily |
2 | Weekly |
3 | Monthly |
4 | Querterly |
5 | Semiannually |
6 | Annually |
Permitted values — validated against the calculation_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Daily | no label seeded |
2 | Weekly | no label seeded |
3 | Monthly | no label seeded |
4 | Querterly | no label seeded |
5 | Semiannually | no label seeded |
6 | Annually | no label seeded |
dateBasisPermitted values — validated against the date_difference parameter.
| Value | Meaning |
|---|---|
1 | 30/360 |
2 | 30/365 |
3 | Actual/360 |
4 | Actual/365 |
5 | Actual/Actual |
Permitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | 30/360 | no label seeded |
2 | 30/365 | no label seeded |
3 | Actual/360 | no label seeded |
4 | Actual/365 | no label seeded |
5 | Actual/Actual | no label seeded |
isCalculationPeriodicalnametypePermitted values — validated against the accrual_product_type parameter.
| Value | Meaning |
|---|---|
1 | Loan |
2 | Bond |
3 | Bill |
4 | Expense |
Permitted values — validated against the accrual_product_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Loan | no label seeded |
2 | Bond | no label seeded |
3 | Bill | no label seeded |
4 | Expense | no label seeded |
update-accrual-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-accrual-product-field-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 IEnumerable<AccrualProductFieldDto>.
| Field | Declared type | Nullable |
|---|---|---|
FieldId | Guid? | yes |
Name | string | no |
IsActive | bool? | yes |
DataType | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
path Parameters
idget-accrual-product-field-by-id › 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.
dataTypePermitted values — validated against the field_data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | System.Int32 | no label seeded |
2 | System.String | no label seeded |
3 | System.Decimal | no label seeded |
4 | System.DateTime | no label seeded |
5 | System.DateOnly | no label seeded |
fieldIdisActivenamecreate accrual product field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the create-accrual-product-field service definition through POST /products/{id}/fields.
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_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
path Parameters
idcreate accrual product field › Request Body
dataTypePermitted values — validated against the field_data_type parameter.
| Value | Meaning |
|---|---|
1 | System.Int32 |
2 | System.String |
3 | System.Decimal |
4 | System.DateTime |
5 | System.DateOnly |
Permitted values — validated against the field_data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | System.Int32 | no label seeded |
2 | System.String | no label seeded |
3 | System.Decimal | no label seeded |
4 | System.DateTime | no label seeded |
5 | System.DateOnly | no label seeded |
namecreate accrual product field › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-accrual-product-field
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_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_4 | 400 | ACCRUAL_PRODUCT_FIELDS_IS_NOT_FOUND | Fields is cannot be found with given field: {0} |
path Parameters
idfieldIdupdate-accrual-product-field › 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 Accrual Product Field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-accrual-product-field service definition through DELETE /products/{id}/fields/{fieldId}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_20 | 400 | ACCRUAL_PRODUCT_FIELD_IS_USED_CALCULATIONS | Field is used while saving a transaction. It cannot be deleted. |
ERR_ACCRL_4 | 400 | ACCRUAL_PRODUCT_FIELDS_IS_NOT_FOUND | Fields is cannot be found with given field: {0} |
path Parameters
idfieldIdDelete Accrual Product Field › 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-accrual-product-formula-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 IEnumerable<AccrualProductFormulaDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccrualProductFormulaId | Guid? | yes |
Code | string | no |
Description | string | no |
FormulaDefinitionId | Guid? | yes |
IsEarlyPaymentFormula | bool? | yes |
IsEarlyClosureFormula | bool? | yes |
IsPeriodicalCalculationFormula | bool? | yes |
IsDueCollectionFormula | bool? | yes |
HasEarlyOperations | bool? | yes |
IsActive | bool? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
path Parameters
idget-accrual-product-formula-by-id › 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.
accrualProductFormulaIdcodedescriptionformulaDefinitionIdhasEarlyOperationsisActiveisDueCollectionFormulaisEarlyClosureFormulaisEarlyPaymentFormulaisPeriodicalCalculationFormulacreate-accrual-product-formula
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_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_22 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION_EARLYPAYMENT_AND_EARLY_CALCULATION | It is not allowed to have more than formula for early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_27 | 400 | ACCRUAL_PRODUCT_FORMULA_CODE_MUST_BE_UNIQUE_FOR_EACH_PRODUCT | It is not allowed to have same code value under one product. |
path Parameters
idcreate-accrual-product-formula › Request Body
codedescriptionformulaDefinitionIdhasEarlyOperationsisDueCollectionFormulaisEarlyClosureFormulaisEarlyPaymentFormulaisPeriodicalCalculationFormulacreate-accrual-product-formula › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
Save Accrual Product Formula
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the save-accrual-product-formula service definition through PUT /products/{id}/formulas/save.
Turkish display name: Reeskont Ürün Formüüleri Kaydetme
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_22 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION_EARLYPAYMENT_AND_EARLY_CALCULATION | It is not allowed to have more than formula for early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_27 | 400 | ACCRUAL_PRODUCT_FORMULA_CODE_MUST_BE_UNIQUE_FOR_EACH_PRODUCT | It is not allowed to have same code value under one product. |
path Parameters
idSave Accrual Product Formula › 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 Accrual Product Formula
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the update-accrual-product-formula service definition through PUT /products/{id}/formulas/{accrualProductFormulaId}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_21 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION | Product has to have a formula for periodical calculation, early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_22 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION_EARLYPAYMENT_AND_EARLY_CALCULATION | It is not allowed to have more than formula for early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_23 | 400 | ACCRUAL_PRODUCT_FORMULA_NOT_FOUND | There is no product formula: {0}. |
ERR_ACCRL_27 | 400 | ACCRUAL_PRODUCT_FORMULA_CODE_MUST_BE_UNIQUE_FOR_EACH_PRODUCT | It is not allowed to have same code value under one product. |
path Parameters
idaccrualProductFormulaIdUpdate Accrual Product Formula › Request Body
codedescriptionformulaDefinitionIdhasEarlyOperationsisActiveisDueCollectionFormulaisEarlyClosureFormulaisEarlyPaymentFormulaisPeriodicalCalculationFormulaUpdate Accrual Product Formula › 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 Accrual Product Formula
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-accrual-product-formula service definition through DELETE /products/{id}/formulas/{accrualProductFormulaId}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCRL_2 | 400 | PRODUCT_IS_NOT_FOUND | Product is cannot be found with the given: {0}. |
ERR_ACCRL_21 | 400 | ACCRUAL_PRODUCT_FORMULA_DEFINITION | Product has to have a formula for periodical calculation, early payment calculation, early closure calculation and due collection calculation. |
ERR_ACCRL_23 | 400 | ACCRUAL_PRODUCT_FORMULA_NOT_FOUND | There is no product formula: {0}. |
ERR_ACCRL_24 | 400 | ACCRUAL_PRODUCT_FORMULA_IS_USED_CALCULATIONS | Product formula is used to in calculations. It cannot be deleted. |
path Parameters
idaccrualProductFormulaIdDelete Accrual Product Formula › 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.