customer-loan-collections
Operations addressed under /customer-loan-collections — 13 operations.
get-customer-loan-collection-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<CustomerLoanCollectionDto>.
| Field | Declared type | Nullable |
|---|---|---|
LoanCollectionId | Guid | no |
InstallmentId | Guid | no |
CollectionDate | DateOnly? | yes |
AccountingEntryId | Guid? | yes |
AccountId | Guid? | yes |
CollectionType | int | no |
CollectionResource | int | no |
CollectionStatus | int | no |
InstallmentType | int | no |
InstallmentTotalAmount | decimal? | yes |
CollectionAmount | decimal? | yes |
DiscountAmount | decimal? | yes |
CancelType | int? | yes |
CancelDescription | string | no |
CancelDate | DateOnly? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-customer-loan-collection-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.
accountIdaccountingEntryIdcancelDatecancelDescriptioncancelTypePermitted values — validated against the collection_cancel_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | customer request | en: müşteri isteği · tr: müşteri talebi · ar: طلب العميل |
collectionAmountcollectionDatecollectionResourcePermitted values — validated against the collection_resource parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | from account | en: from account · tr: hesaptan · ar: من الحساب |
2 | from safe | en: from safe · tr: kasadan · ar: آمن من |
3 | ledger | tr: muhasebe hesabı |
collectionStatuscollectionTypePermitted 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 |
discountAmountidinstallmentIdinstallmentTotalAmountinstallmentTypePermitted values — validated against the installment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | installment | en: installment · tr: taksit · ar: تقسيط |
2 | delay penalty | en: delay penalty · tr: gecikme cezası · ar: غرامة التأخير |
loanCollectionIdcreate-customer-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_10 | 400 | LOAN_COLLECTION_MUST_BE_ACTIVE | Loan collection is not active. :{0} |
ERR_COLLECTION_11 | 400 | LOAN_COLLECTION_ITEM_SEQUENCE_MUST_BE_NOT_NULL | Loan collection sequence cannot be found. |
ERR_COLLECTION_15 | 400 | LOAN_COLLECTION_SUM_COLLECTION_DETAIL_AMOUNT_TO_COLLECTION_AMOUNT | The sum of the amounts in the collection detail list must be equal to the collection amount. |
ERR_COLLECTION_2 | 400 | LOAN_COLLECTION_NOT_FOUND | Loan collection cannot be found. : {0} |
create-customer-loan-collection › Request Body
collectionAmountcollectionResourcePermitted values — validated against the collection_resource parameter.
| Value | Meaning |
|---|---|
1 | from account |
2 | from safe |
3 | ledger |
Permitted values — validated against the collection_resource parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | from account | en: from account · tr: hesaptan · ar: من الحساب |
2 | from safe | en: from safe · tr: kasadan · ar: آمن من |
3 | ledger | tr: muhasebe hesabı |
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 |
discountAmountinstallmentIdinstallmentTotalAmountinstallmentTypePermitted values — validated against the installment_type parameter.
| Value | Meaning |
|---|---|
1 | installment |
2 | delay penalty |
Permitted values — validated against the installment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | installment | en: installment · tr: taksit · ar: تقسيط |
2 | delay penalty | en: delay penalty · tr: gecikme cezası · ar: غرامة التأخير |
loanCollectionIdaccountIdcreate-customer-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-customer-loan-collection-detail-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<CustomerLoanCollectionDetailListDto>.
| Field | Declared type | Nullable |
|---|---|---|
CollectionDetails | List<CustomerLoanCollectionDetailDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-customer-loan-collection-detail-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.
accountIdaccountingEntryIdcancelDatecancelDescriptioncancelTypePermitted values — validated against the collection_cancel_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | customer request | en: müşteri isteği · tr: müşteri talebi · ar: طلب العميل |
collectionAmountcollectionDatecollectionResourcePermitted values — validated against the collection_resource parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | from account | en: from account · tr: hesaptan · ar: من الحساب |
2 | from safe | en: from safe · tr: kasadan · ar: آمن من |
3 | ledger | tr: muhasebe hesabı |
collectionStatuscollectionTypePermitted 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 |
discountAmountidinstallmentIdinstallmentTotalAmountinstallmentTypePermitted values — validated against the installment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | installment | en: installment · tr: taksit · ar: تقسيط |
2 | delay penalty | en: delay penalty · tr: gecikme cezası · ar: غرامة التأخير |
loanCollectionIdget-customer-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 CustomerLoanCollectionDto.
| Field | Declared type | Nullable |
|---|---|---|
LoanCollectionId | Guid | no |
InstallmentId | Guid | no |
CollectionDate | DateOnly? | yes |
AccountingEntryId | Guid? | yes |
AccountId | Guid? | yes |
CollectionType | int | no |
CollectionResource | int | no |
CollectionStatus | int | no |
InstallmentType | int | no |
InstallmentTotalAmount | decimal? | yes |
CollectionAmount | decimal? | yes |
DiscountAmount | decimal? | yes |
CancelType | int? | yes |
CancelDescription | string | no |
CancelDate | DateOnly? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idget-customer-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.
accountIdaccountingEntryIdcancelDatecancelDescriptioncancelTypePermitted values — validated against the collection_cancel_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | customer request | en: müşteri isteği · tr: müşteri talebi · ar: طلب العميل |
collectionAmountcollectionDatecollectionResourcePermitted values — validated against the collection_resource parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | from account | en: from account · tr: hesaptan · ar: من الحساب |
2 | from safe | en: from safe · tr: kasadan · ar: آمن من |
3 | ledger | tr: muhasebe hesabı |
collectionStatuscollectionTypePermitted 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 |
discountAmountidinstallmentIdinstallmentTotalAmountinstallmentTypePermitted values — validated against the installment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | installment | en: installment · tr: taksit · ar: تقسيط |
2 | delay penalty | en: delay penalty · tr: gecikme cezası · ar: غرامة التأخير |
loanCollectionIdupdate-customer-loan-collection-accounting-entry-id
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_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idupdate-customer-loan-collection-accounting-entry-id › Request Body
accountingEntryIdupdate-customer-loan-collection-accounting-entry-id › 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.
cancel-customer-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_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
ERR_COLLECTION_20 | 400 | CUSTOMER_LOAN_COLLECTION_CANCEL_TYPE_MUST_BE_NULL | This collection has been cancelled. |
path Parameters
idcancel-customer-loan-collection › Request Body
cancelDescriptioncancelTypePermitted values — validated against the collection_cancel_type parameter.
| Value | Meaning |
|---|---|
1 | müşteri isteği |
Permitted values — validated against the collection_cancel_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | customer request | en: müşteri isteği · tr: müşteri talebi · ar: طلب العميل |
cancel-customer-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-customer-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 CustomerLoanCollectionDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
DelayPenalties | List<InstallmentDelayPenaltyDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idget-customer-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.
accountIdaccountingEntryIdcancelDatecancelDescriptioncancelTypePermitted values — validated against the collection_cancel_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | customer request | en: müşteri isteği · tr: müşteri talebi · ar: طلب العميل |
collectionAmountcollectionDatecollectionResourcePermitted values — validated against the collection_resource parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | from account | en: from account · tr: hesaptan · ar: من الحساب |
2 | from safe | en: from safe · tr: kasadan · ar: آمن من |
3 | ledger | tr: muhasebe hesabı |
collectionStatuscollectionTypePermitted 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 |
discountAmountidinstallmentIdinstallmentTotalAmountinstallmentTypePermitted values — validated against the installment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | installment | en: installment · tr: taksit · ar: تقسيط |
2 | delay penalty | en: delay penalty · tr: gecikme cezası · ar: غرامة التأخير |
loanCollectionIdget-installment-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<InstallmentDelayPenaltyDto>.
| Field | Declared type | Nullable |
|---|---|---|
AccountingEntryId | Guid? | yes |
DelayAmount | decimal? | yes |
TotalDelayAmount | decimal? | yes |
FromAmount | decimal? | yes |
Status | int | no |
DelayDayCount | int? | yes |
Rate | decimal? | yes |
CalculatedMethod | int | no |
Taxes | List<InstallmentDelayPenaltyTaxDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-installment-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.
accountingEntryIdcalculatedMethoddelayAmountdelayDayCountfromAmountidratestatusPermitted values — validated against the delay_penalty_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
4 | Kısmi Ödendi | en: Partial Collection · tr: Kısmi Ödendi · ar: مجموعة جزئية |
3 | collected | en: collected · tr: ödendi · ar: مُجمَّع |
1 | active | en: Active · tr: Aktif · ar: نشط |
2 | passive | en: Passive · tr: Pasif · ar: مبادلة |
totalDelayAmountcreate-installment-delay-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_COLLECTION_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idcreate-installment-delay-penalty › Request Body
calculatedMethoddelayAmountdelayDayCountfromAmountratetotalDelayAmountcreate-installment-delay-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.
idget-installment-delay-penalty-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 InstallmentDelayPenaltyDto.
| Field | Declared type | Nullable |
|---|---|---|
AccountingEntryId | Guid? | yes |
DelayAmount | decimal? | yes |
TotalDelayAmount | decimal? | yes |
FromAmount | decimal? | yes |
Status | int | no |
DelayDayCount | int? | yes |
Rate | decimal? | yes |
CalculatedMethod | int | no |
Taxes | List<InstallmentDelayPenaltyTaxDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_COLLECTION_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
ERR_COLLECTION_22 | 400 | LOAN_COLLECTION_INSTALLMENT_DELAY_PENALTIES_NOT_FOUND | Installment delay penalty cannot be found. Installment Delay Penalty:{0} |
path Parameters
idinstallmentDelayPenaltyIdget-installment-delay-penalty-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.
accountingEntryIdcalculatedMethoddelayAmountdelayDayCountfromAmountidratestatusPermitted values — validated against the delay_penalty_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
4 | Kısmi Ödendi | en: Partial Collection · tr: Kısmi Ödendi · ar: مجموعة جزئية |
3 | collected | en: collected · tr: ödendi · ar: مُجمَّع |
1 | active | en: Active · tr: Aktif · ar: نشط |
2 | passive | en: Passive · tr: Pasif · ar: مبادلة |
totalDelayAmountupdate-installment-delay-penalty-accounting-entry-id
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_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
ERR_COLLECTION_22 | 400 | LOAN_COLLECTION_INSTALLMENT_DELAY_PENALTIES_NOT_FOUND | Installment delay penalty cannot be found. Installment Delay Penalty:{0} |
path Parameters
idinstallmentDelayPenaltyIdupdate-installment-delay-penalty-accounting-entry-id › Request Body
accountingEntryIdupdate-installment-delay-penalty-accounting-entry-id › 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-installment-delay-penalty-status
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_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
ERR_COLLECTION_22 | 400 | LOAN_COLLECTION_INSTALLMENT_DELAY_PENALTIES_NOT_FOUND | Installment delay penalty cannot be found. Installment Delay Penalty:{0} |
path Parameters
idinstallmentDelayPenaltyIdupdate-installment-delay-penalty-status › Request Body
statusPermitted values — validated against the delay_penalty_status parameter.
| Value | Meaning |
|---|---|
4 | Partial Collection |
3 | collected |
1 | Active |
2 | Passive |
Permitted values — validated against the delay_penalty_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
4 | Kısmi Ödendi | en: Partial Collection · tr: Kısmi Ödendi · ar: مجموعة جزئية |
3 | collected | en: collected · tr: ödendi · ar: مُجمَّع |
1 | active | en: Active · tr: Aktif · ar: نشط |
2 | passive | en: Passive · tr: Pasif · ar: مبادلة |
update-installment-delay-penalty-status › 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-customer-loan-collection-installment-id
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_18 | 400 | CUSTOMER_LOAN_COLLECTION_MUST_BE_NOT_NULL | Customer loan collection cannot be found. :{0} |
path Parameters
idupdate-customer-loan-collection-installment-id › Request Body
installmentIdupdate-customer-loan-collection-installment-id › 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.