loan-collections
Operations addressed under /loan-collections — 11 operations.
create-loan-collection
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_COLLECTION_1 | 400 | LOAN_COLLECTION_MUST_BE_NULL_BY_PRODUCTID | There is an active collection definition with this product, collection type and follow type. : {0} |
create-loan-collection › Request Body
collectionTypePermitted values — validated against the collection_type parameter.
| Value | Meaning |
|---|---|
1 | full amount |
2 | partial collection |
3 | early collection |
4 | on time collection |
5 | early repayment |
6 | interim payment |
Permitted values — validated against the collection_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | full collection | en: full amount · tr: tam tahsilat · ar: المبلغ الكامل |
2 | partial collection | en: partial collection · tr: kısmi tahsilat · ar: مُجمعة جزئية |
3 | early collection | en: early collection · tr: erken tahsilat · ar: تجميع مبكر |
4 | on time collection | en: on time collection · tr: vadesinde tahsilat · ar: جمع في الوقت المحدد |
5 | early repayment | en: early repayment · tr: erken kapama · ar: السداد المبكر |
6 | interim payment | no label seeded |
descriptionloanProductIdnamefollowTypeIdcreate-loan-collection › 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.
idget-loan-collection-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 LoanCollectionDto.
| Field | Declared type | Nullable |
|---|---|---|
LoanProductId | Guid? | yes |
Name | string | no |
Description | string | no |
IsActive | bool | no |
CollectionType | int | no |
FollowTypeId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
path Parameters
idget-loan-collection-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.
descriptionidisActiveloanProductIdnameupdate-loan-collection
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_COLLECTION_1 | 400 | LOAN_COLLECTION_MUST_BE_NULL_BY_PRODUCTID | There is an active collection definition with this product, collection type and follow type. : {0} |
ERR_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
path Parameters
idupdate-loan-collection › Request Body
collectionTypePermitted values — validated against the collection_type parameter.
| Value | Meaning |
|---|---|
1 | full amount |
2 | partial collection |
3 | early collection |
4 | on time collection |
5 | early repayment |
6 | interim payment |
Permitted values — validated against the collection_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | full collection | en: full amount · tr: tam tahsilat · ar: المبلغ الكامل |
2 | partial collection | en: partial collection · tr: kısmi tahsilat · ar: مُجمعة جزئية |
3 | early collection | en: early collection · tr: erken tahsilat · ar: تجميع مبكر |
4 | on time collection | en: on time collection · tr: vadesinde tahsilat · ar: جمع في الوقت المحدد |
5 | early repayment | en: early repayment · tr: erken kapama · ar: السداد المبكر |
6 | interim payment | no label seeded |
isActiveloanProductIdnamedescriptionfollowTypeIdupdate-loan-collection › 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-collection
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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
ERR_COLLECTION_3 | 400 | LOAN_COLLECTION_USE_TO_CUSTOMER_COLLECTION_FOUND | This definition cannot be deleted because a collection has been made with this definition. |
path Parameters
iddelete-loan-collection › 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-tax-delay-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<TaxDelayPenaltyDto>.
| 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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-tax-delay-penalty-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-collection-delay-penalty-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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
ERR_COLLECTION_8 | 400 | LOAN_COLLECTION_TAX_DELAY_PENALTY_MUST_BE_NOT_SAME_TAX | Tax has already been registered this loan collection definition. :{0} |
path Parameters
idcreate-loan-collection-delay-penalty-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-collection-delay-penalty-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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
ERR_COLLECTION_9 | 400 | LOAN_COLLECTION_TAX_DELAY_PENALTY_MUST_BE_NOT_NULL | Delay penalty tax cannot be found. :{0} |
path Parameters
iddelayPenaltyTaxIddelete-loan-collection-delay-penalty-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-loan-collection-details-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 LoanCollectionDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemSequences | List<LoanCollectionSequenceDto> (collection) | no |
Taxes | List<TaxDelayPenaltyDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
path Parameters
idget-loan-collection-details-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.
collectionTypePermitted values — validated against the collection_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | full collection | en: full amount · tr: tam tahsilat · ar: المبلغ الكامل |
2 | partial collection | en: partial collection · tr: kısmi tahsilat · ar: مُجمعة جزئية |
3 | early collection | en: early collection · tr: erken tahsilat · ar: تجميع مبكر |
4 | on time collection | en: on time collection · tr: vadesinde tahsilat · ar: جمع في الوقت المحدد |
5 | early repayment | en: early repayment · tr: erken kapama · ar: السداد المبكر |
6 | interim payment | no label seeded |
descriptionfollowTypeIdidisActiveloanProductIdnameget-loan-collection-sequences-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<LoanCollectionSequenceDto>.
| Field | Declared type | Nullable |
|---|---|---|
SequenceNo | int? | yes |
CollectionItem | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-loan-collection-sequences-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.
collectionItemPermitted values — validated against the collection_item parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | principal amount | en: principal amount · tr: ana para · ar: المبلغ الرئيسي |
2 | profit amount | en: profit amount · tr: kâr tutarı · ar: مبلغ الربح |
5 | Gecikme Cezası Ana Para | en: Delay Penalty Pricipal Amount · tr: Gecikme Cezası Ana Para · ar: مبلغ العقوبة على التأخير |
6 | Gecikme Cezası Vergi BSMV | en: Delay Penalty Tax BSMV · tr: Gecikme Cezası Vergi BSMV · ar: ضرائب غرامة التأخير وتُعرف أيضاً بضريبة القيمة المضافة على الخدمات (BSMV) |
7 | Gecikme Cezası Vergi KKDF | en: Delay Penalty Tax KKDF · tr: Gecikme Cezası Vergi KKDF · ar: ضريبة غرامة التأخير |
idsequenceNocreate-loan-collection-sequence
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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
ERR_COLLECTION_4 | 400 | LOAN_COLLECTION_ITEM_DUPLICATE_FOUND | This collection item already exists.Item:{0} |
path Parameters
idcreate-loan-collection-sequence › 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-collection-sequence
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_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
ERR_COLLECTION_6 | 400 | LOAN_COLLECTION_SEQUENCE_MUST_BE_NOT_NULL | Loan collection item cannot be found. : {0} |
path Parameters
idsequenceIddelete-loan-collection-sequence › 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.