products
Operations addressed under /products — 36 operations.
get-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<ProductDto>.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
ProductGroupId | Guid? | yes |
FundingSource | int? | yes |
ProposalValidityDay | int | no |
ProfitCalculationMethod | int? | yes |
FinanceType | int? | yes |
DateDifference | int? | yes |
ProductStatus | int? | yes |
IsActive | bool | no |
AccountProductId | Guid | no |
CashType | int? | yes |
RateTypes | List<int> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-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.
accountProductIdcashTypePermitted values — validated against the cash_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقدي |
2 | Non Cash | en: Non Cash · tr: Peşin Olmayan · ar: غير نقدي |
codedateDifferencePermitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 360 days, assumes 30 days between installments. · tr: Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 360 يومًا، ويفترض 30 يومًا بين الأقساط. |
2 | Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 365 days, assumes 30 days between installments. · tr: Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 365 يومًا، ويفترض 30 يومًا بين الأقساط. |
3 | Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 360 days, taking into account the actual difference between installments. · tr: Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 360 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
4 | Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 365 days, taking into account the actual difference between installments. · tr: Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 365 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
5 | O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. | en: Considers the actual number of days in that year and the actual difference between installments. · tr: O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. · ar: يأخذ في الاعتبار عدد الأيام الفعلي في تلك السنة والفرق الفعلي بين الأقساط. |
descriptionfinanceTypePermitted values — validated against the finance_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Karz | no label seeded |
2 | Murabaha | no label seeded |
fundingSourcePermitted values — validated against the funding_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | equity | no label seeded |
2 | pool | no label seeded |
idisActivenameproductGroupIdproductStatusPermitted values — validated against the product_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Sıfır Ürün | en: New Product · ar: منتج جديد |
2 | İkinci El Ürün | en: Second Hand Product · ar: منتج مستعمل |
profitCalculationMethodPermitted values — validated against the profit_calculation_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Fixed Amount-fa | no label seeded |
2 | Reducing Balance-irr | no label seeded |
3 | Flat Rate-fr | no label seeded |
4 | XIRR | no label seeded |
5 | PMT | no label seeded |
proposalValidityDayrateTypescreate-loan-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_LPRDCT_6 | 400 | PRODUCT_IS_NOT_NULL | There is a definition with the same ProductCode: {0} |
ERR_LPRDCT_7 | 400 | PRODUCT_GROUP_IS_NULL | ProductGroup is not found. ProductGroupId: {0} |
ERR_LPRDCT_8 | 400 | PRODUCT_IS_NOT_ACTIVE | ProductGroup is not active. ProductGroupId: {0} |
ERR_LPRDCT_9 | 400 | PRODUCT_GROUP_LIST_NOT_FOUND | There should not be a different product group under the group to which the product will be associated. |
create-loan-product › Request Body
accountProductIdcashTypePermitted values — validated against the cash_type parameter.
| Value | Meaning |
|---|---|
1 | Cash |
2 | Non Cash |
Permitted values — validated against the cash_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقدي |
2 | Non Cash | en: Non Cash · tr: Peşin Olmayan · ar: غير نقدي |
codedateDifferencePermitted values — validated against the date_difference parameter.
| Value | Meaning |
|---|---|
1 | Considers a year as 360 days, assumes 30 days between installments. |
2 | Considers a year as 365 days, assumes 30 days between installments. |
3 | Considers a year as 360 days, taking into account the actual difference between installments. |
4 | Considers a year as 365 days, taking into account the actual difference between installments. |
5 | Considers the actual number of days in that year and the actual difference between installments. |
Permitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 360 days, assumes 30 days between installments. · tr: Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 360 يومًا، ويفترض 30 يومًا بين الأقساط. |
2 | Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 365 days, assumes 30 days between installments. · tr: Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 365 يومًا، ويفترض 30 يومًا بين الأقساط. |
3 | Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 360 days, taking into account the actual difference between installments. · tr: Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 360 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
4 | Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 365 days, taking into account the actual difference between installments. · tr: Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 365 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
5 | O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. | en: Considers the actual number of days in that year and the actual difference between installments. · tr: O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. · ar: يأخذ في الاعتبار عدد الأيام الفعلي في تلك السنة والفرق الفعلي بين الأقساط. |
descriptionfinanceTypePermitted values — validated against the finance_type parameter.
| Value | Meaning |
|---|---|
1 | Karz |
2 | Murabaha |
Permitted values — validated against the finance_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Karz | no label seeded |
2 | Murabaha | no label seeded |
fundingSourcePermitted values — validated against the funding_source parameter.
| Value | Meaning |
|---|---|
1 | equity |
2 | pool |
Permitted values — validated against the funding_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | equity | no label seeded |
2 | pool | no label seeded |
nameproductGroupIdproductStatusPermitted values — validated against the product_status parameter.
| Value | Meaning |
|---|---|
1 | New Product |
2 | Second Hand Product |
Permitted values — validated against the product_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Sıfır Ürün | en: New Product · ar: منتج جديد |
2 | İkinci El Ürün | en: Second Hand Product · ar: منتج مستعمل |
profitCalculationMethodPermitted values — validated against the profit_calculation_method parameter.
| Value | Meaning |
|---|---|
1 | Fixed Amount-fa |
2 | Reducing Balance-irr |
3 | Flat Rate-fr |
4 | XIRR |
5 | PMT |
Permitted values — validated against the profit_calculation_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Fixed Amount-fa | no label seeded |
2 | Reducing Balance-irr | no label seeded |
3 | Flat Rate-fr | no label seeded |
4 | XIRR | no label seeded |
5 | PMT | no label seeded |
proposalValidityDaycreate-loan-product › 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.
idupdate-product-maturity-rate
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
update-product-maturity-rate › Request Body
currencyIdmaturitymaxRateminRateupdate-product-maturity-rate › 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-product-tree-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
query Parameters
orderByorderSortpageIndexpageSizeget-product-tree-list › 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 |
isActiveparentProductGroupCodeproductGroupCodeget-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 ProductDto.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
ProductGroupId | Guid? | yes |
FundingSource | int? | yes |
ProposalValidityDay | int | no |
ProfitCalculationMethod | int? | yes |
FinanceType | int? | yes |
DateDifference | int? | yes |
ProductStatus | int? | yes |
IsActive | bool | no |
AccountProductId | Guid | no |
CashType | int? | yes |
RateTypes | List<int> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idget-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.
accountProductIdcashTypePermitted values — validated against the cash_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقدي |
2 | Non Cash | en: Non Cash · tr: Peşin Olmayan · ar: غير نقدي |
codedateDifferencePermitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 360 days, assumes 30 days between installments. · tr: Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 360 يومًا، ويفترض 30 يومًا بين الأقساط. |
2 | Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 365 days, assumes 30 days between installments. · tr: Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 365 يومًا، ويفترض 30 يومًا بين الأقساط. |
3 | Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 360 days, taking into account the actual difference between installments. · tr: Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 360 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
4 | Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 365 days, taking into account the actual difference between installments. · tr: Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 365 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
5 | O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. | en: Considers the actual number of days in that year and the actual difference between installments. · tr: O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. · ar: يأخذ في الاعتبار عدد الأيام الفعلي في تلك السنة والفرق الفعلي بين الأقساط. |
descriptionfinanceTypePermitted values — validated against the finance_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Karz | no label seeded |
2 | Murabaha | no label seeded |
fundingSourcePermitted values — validated against the funding_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | equity | no label seeded |
2 | pool | no label seeded |
idisActivenameproductGroupIdproductStatusPermitted values — validated against the product_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Sıfır Ürün | en: New Product · ar: منتج جديد |
2 | İkinci El Ürün | en: Second Hand Product · ar: منتج مستعمل |
profitCalculationMethodPermitted values — validated against the profit_calculation_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Fixed Amount-fa | no label seeded |
2 | Reducing Balance-irr | no label seeded |
3 | Flat Rate-fr | no label seeded |
4 | XIRR | no label seeded |
5 | PMT | no label seeded |
proposalValidityDayupdate-loan-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_7 | 400 | PRODUCT_GROUP_IS_NULL | ProductGroup is not found. ProductGroupId: {0} |
ERR_LPRDCT_8 | 400 | PRODUCT_IS_NOT_ACTIVE | ProductGroup is not active. ProductGroupId: {0} |
ERR_LPRDCT_9 | 400 | PRODUCT_GROUP_LIST_NOT_FOUND | There should not be a different product group under the group to which the product will be associated. |
path Parameters
idupdate-loan-product › Request Body
accountProductIdcashTypePermitted values — validated against the cash_type parameter.
| Value | Meaning |
|---|---|
1 | Cash |
2 | Non Cash |
Permitted values — validated against the cash_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقدي |
2 | Non Cash | en: Non Cash · tr: Peşin Olmayan · ar: غير نقدي |
dateDifferencePermitted values — validated against the date_difference parameter.
| Value | Meaning |
|---|---|
1 | Considers a year as 360 days, assumes 30 days between installments. |
2 | Considers a year as 365 days, assumes 30 days between installments. |
3 | Considers a year as 360 days, taking into account the actual difference between installments. |
4 | Considers a year as 365 days, taking into account the actual difference between installments. |
5 | Considers the actual number of days in that year and the actual difference between installments. |
Permitted values — validated against the date_difference parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 360 days, assumes 30 days between installments. · tr: Bir yılı 360, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 360 يومًا، ويفترض 30 يومًا بين الأقساط. |
2 | Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. | en: Considers a year as 365 days, assumes 30 days between installments. · tr: Bir yılı 365, taksitler arasındaki farkı 30 gün kabul eder. · ar: يعتبر السنة 365 يومًا، ويفترض 30 يومًا بين الأقساط. |
3 | Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 360 days, taking into account the actual difference between installments. · tr: Bir yılı 360 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 360 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
4 | Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. | en: Considers a year as 365 days, taking into account the actual difference between installments. · tr: Bir yılı 365 olarak, taksitler arasındaki gerçek farkı dikkate alır. · ar: يعتبر السنة 365 يومًا، مع مراعاة الفرق الفعلي بين الأقساط. |
5 | O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. | en: Considers the actual number of days in that year and the actual difference between installments. · tr: O yıl içindeki gün sayısını ve taksitler arasındaki gerçek farkı dikkate alır. · ar: يأخذ في الاعتبار عدد الأيام الفعلي في تلك السنة والفرق الفعلي بين الأقساط. |
descriptionfinanceTypePermitted values — validated against the finance_type parameter.
| Value | Meaning |
|---|---|
1 | Karz |
2 | Murabaha |
Permitted values — validated against the finance_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Karz | no label seeded |
2 | Murabaha | no label seeded |
fundingSourcePermitted values — validated against the funding_source parameter.
| Value | Meaning |
|---|---|
1 | equity |
2 | pool |
Permitted values — validated against the funding_source parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | equity | no label seeded |
2 | pool | no label seeded |
isActivenameproductGroupIdproductStatusPermitted values — validated against the product_status parameter.
| Value | Meaning |
|---|---|
1 | New Product |
2 | Second Hand Product |
Permitted values — validated against the product_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Sıfır Ürün | en: New Product · ar: منتج جديد |
2 | İkinci El Ürün | en: Second Hand Product · ar: منتج مستعمل |
profitCalculationMethodPermitted values — validated against the profit_calculation_method parameter.
| Value | Meaning |
|---|---|
1 | Fixed Amount-fa |
2 | Reducing Balance-irr |
3 | Flat Rate-fr |
4 | XIRR |
5 | PMT |
Permitted values — validated against the profit_calculation_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Fixed Amount-fa | no label seeded |
2 | Reducing Balance-irr | no label seeded |
3 | Flat Rate-fr | no label seeded |
4 | XIRR | no label seeded |
5 | PMT | no label seeded |
proposalValidityDayupdate-loan-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-product-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<CurrencyDto>.
| Field | Declared type | Nullable |
|---|---|---|
CurrencyNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-product-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.
currencyNumberidcreate-loan-product-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_36 | 400 | SAME_PRODUCT_CURRENCY | The currency type sent is defined in this product. |
path Parameters
idcreate-loan-product-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-loan-product-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_16 | 400 | PRODUCT_CURRENCIES_NOT_FOUND | Product - Currency record is not found. Id : {0} |
path Parameters
idproductCurrencyIddelete-loan-product-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-product-customer-map-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<CustomerMapDto>.
| Field | Declared type | Nullable |
|---|---|---|
CustomerType | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-product-customer-map-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.
customerTypeidcreate-loan-product-customer-map
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_32 | 400 | SAME_PRODUCT_CUSTOMER_TYPE | Customer type has been saved before. CustomerType:{0} |
path Parameters
idcreate-loan-product-customer-map › 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-loan-product-customer-map
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_29 | 400 | PRODUCT_CUSTOMER_MAPS_NOT_FOUND | Product-Customertype record is not found. Id: {0} |
path Parameters
idcustomerMapIddelete-loan-product-customer-map › 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-product-details-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request body description
The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit cashType, which this document nevertheless marks required because the catalog declares it so.
Response body, read from the service source
The route declares its response as ProductDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
SpecialCondition | SpecialConditionDto | no |
CustomerMaps | List<CustomerMapDto> (collection) | no |
Currencies | List<CurrencyDto> (collection) | no |
Discounts | List<DiscountDto> (collection) | no |
Penalties | List<PenaltyDto> (collection) | no |
PaybackPlans | List<PaybackPlanDto> (collection) | no |
MaturityRateMatrix | List<MaturityRateMatrixDto> (collection) | no |
Taxes | List<TaxDto> (collection) | no |
ExpenseItems | List<ExpenseItemDto> (collection) | no |
ProductRisks | List<LoanProductRiskLevelDto> (collection) | no |
Fields | List<FieldDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idget-product-details-by-id › Request Body
cashTypePermitted values — validated against the cash_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقدي |
2 | Non Cash | en: Non Cash · tr: Peşin Olmayan · ar: غير نقدي |
get-product-details-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-discount-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<DiscountDto>.
| Field | Declared type | Nullable |
|---|---|---|
DiscountRate | decimal? | yes |
CalculationMethod | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-discount-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-loan-product-discount
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_18 | 400 | PRODUCT_DISCOUNT_FOUND | There is already a early payment discount definition for this product. |
path Parameters
idcreate-loan-product-discount › Request Body
calculationMethodPermitted values — validated against the discount_method parameter.
| Value | Meaning |
|---|---|
1 | General Discount Calculation |
2 | discount_y |
discountRatecreate-loan-product-discount › 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.
iddelete-loan-product-discount
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_20 | 400 | PRODUCT_DISCOUNTS_NOT_FOUND | Early payment discount record is not found. Id: {0} |
path Parameters
iddiscountIddelete-loan-product-discount › 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-product-expense-item-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<ExpenseItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
ExpenseItemId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
get-product-expense-item-list › 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-product-expense-item
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idcreate-product-expense-item › 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-product-expense-item
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_49 | 400 | PRODUCT_EXPENSE_ITEM_NOT_FOUND | not published in this snapshot |
path Parameters
idproductExpenseItemIddelete-product-expense-item › 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-product-field-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<FieldDto>.
| Field | Declared type | Nullable |
|---|---|---|
IsMandatory | bool | no |
BusinessFieldDefinitionId | Guid | no |
LoanProductId | Guid | no |
IsActive | bool? | yes |
SequenceNumber | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-product-field-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.
businessFieldDefinitionIdidisActiveisMandatoryloanProductIdsequenceNumbercreate-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idcreate-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-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_38 | 400 | PRODUCT_FIELDS_NOT_FOUND | Product field record is not found. |
path Parameters
idfieldIddelete-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-loan-product-maturity-rate-matrix-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<MaturityRateMatrixDto>.
| Field | Declared type | Nullable |
|---|---|---|
MinInstallmentCount | int | no |
MaxInstallmentCount | int | no |
DefaultRate | decimal | no |
MinRate | decimal | no |
MaxRate | decimal | no |
MinProductAmount | decimal | no |
MaxProductAmount | decimal | no |
LoanGrantingRate | decimal | no |
RateTypePr | int? | yes |
PercentageRate | decimal? | yes |
CurrencyId | int? | yes |
BasePriceId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-loan-product-maturity-rate-matrix-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.
basePriceIdcurrencyIddefaultRateidloanGrantingRatemaxInstallmentCountmaxProductAmountmaxRatemccminInstallmentCountminProductAmountminRateposcodecreate-maturity-rate-matrix
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_11 | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_INSTALLMENT_COUNT_CONTROL | Min installment count must be less than or equal to max installment count. |
ERR_LPRDCT_12 | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_DEFAULT_RATE_CONTROL | Default rate must be in the range of min rate and max rate. |
ERR_LPRDCT_13 | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_MIN_RATE_CONTROL | Min rate must be less than or equal to max rate. |
ERR_LPRDCT_14 | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_INSTALLMENT_COUNT_SPECIFIC_CONTROL | Min installment counts cannot be smaller than maximum installment counts in a different line, and greater than the min installment counts. |
ERR_LPRDCT_XX | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_MIN_PRODUCT_AMOUNT_CONTROL | not published in this snapshot |
path Parameters
idcreate-maturity-rate-matrix › 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-loan-product-maturity-rate-matrix
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_15 | 400 | PRODUCT_MATURITY_RATE_MATRIX_ITEMS_NOT_FOUND | Maturity rate record is not found. Id: {0} |
path Parameters
idmaturityRateMatrixIddelete-loan-product-maturity-rate-matrix › 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-product-payback-plan-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<PaybackPlanDto>.
| Field | Declared type | Nullable |
|---|---|---|
PaybackPlanMethod | int | no |
MaxPostponedInstallmentCount | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-product-payback-plan-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.
idmaxPostponedInstallmentCountpaybackPlanMethodPermitted values — validated against the payback_plan_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | decreasing_profit | en: Decreasing Profit · tr: Azalan Kar · ar: الربح المتناقص |
2 | equal_installment | en: Equal Installment · tr: Eşit Taksit · ar: قسط متساوي |
3 | fixed_principal | en: Fixed Principal · tr: Sabit Anapara · ar: أصل ثابت |
4 | variable_interest | no label seeded |
10 | baloon_payment | en: Baloon Payment · tr: Balon Ödeme |
11 | irregular_installment | en: Irregular Installment · tr: Düzensiz Ödemeli |
12 | spot_loan | en: Spot Loan · tr: Spot Kredi |
create-loan-product-payback-plan
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_33 | 400 | PRODUCT_PAYBACK_PLANS_RESULT_SAME | Payback plan method type has been saved before. Payback Plan Method:{0} |
path Parameters
idcreate-loan-product-payback-plan › 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-loan-product-payback-plan
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_17 | 400 | PRODUCT_PAYBACK_PLANS_NOT_FOUND | Payback plan information is not found. Id: {0} |
path Parameters
idpaybackPlanIddelete-loan-product-payback-plan › 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-penalty-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<PenaltyDto>.
| Field | Declared type | Nullable |
|---|---|---|
PenaltyType | int | no |
PenaltyRate | decimal? | yes |
MinPenaltyRate | decimal? | yes |
MaxPenaltyRate | decimal? | yes |
CalculationMethod | int | no |
IsDisposable | bool? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-penalty-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-loan-product-penalty
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_23 | 400 | PRODUCT_PENALTIES_MIN_MAX_RATE_CONTROL | Min penalty rate should be smaller than max penalty rate. |
ERR_LPRDCT_24 | 400 | PRODUCT_PENALTIES_PENALTY_RATE_CONTROL | The default rate should be in the range of min rate to max rate. |
ERR_LPRDCT_31 | 400 | PRODUCT_PENALTIES_PENALTY_TYPE_AND_CALCULATION_METHOD_CONTROL | There is already a definition of this type and payment penalty with this method. Type:{0}, Method:{1} |
path Parameters
idcreate-loan-product-penalty › Request Body
calculationMethodPermitted values — validated against the penalty_method parameter.
| Value | Meaning |
|---|---|
1 | General Penalty Calculation |
2 | penalty_y |
isDisposablemaxPenaltyRateminPenaltyRatepenaltyRatepenaltyTypePermitted values — validated against the penalty_type parameter.
| Value | Meaning |
|---|---|
1 | early payment penalty |
2 | delay payment penalty |
Permitted values — validated against the penalty_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | early payment penalty | en: early payment penalty · tr: erken ödeme cezası · ar: غرامة الدفع المبكر |
2 | delay payment penalty | en: delay payment penalty · tr: geç ödeme cezası · ar: غرامة تأخير الدفع |
create-loan-product-penalty › 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.
iddelete-loan-product-penalty
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_26 | 400 | PRODUCT_PENALTIES_NOT_FOUND | Early payment penalty record is not found. |
path Parameters
idpenaltyIddelete-loan-product-penalty › 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-product-tree-category-map
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_47 | 400 | SAME_PRODUCT_TREE_CATEGORY | not published in this snapshot |
path Parameters
idcreate-product-tree-category-map › 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-special-condition
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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idupdate-special-condition › 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-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<TaxDto>.
| Field | Declared type | Nullable |
|---|---|---|
TaxId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-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.
idtaxIdcreate-loan-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
path Parameters
idcreate-loan-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-loan-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_LPRDCT_10 | 400 | PRODUCT_NOT_FOUND | Product is not found. ProductId: {0} |
ERR_LPRDCT_28 | 400 | PRODUCT_TAX_NOT_FOUND | Tax definition record is not found. Id: {0} |
path Parameters
idproductTaxIddelete-loan-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.