loans--vendor-disbursements
Operations addressed under /loans — 79 operations.
Rendered section: This page contains the vendor-disbursements route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.
get-vendor-disbursement-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<VendorDisbursementDto>.
| Field | Declared type | Nullable |
|---|---|---|
InternalVendorId | Guid? | yes |
ExternalVendorId | Guid? | yes |
LoanId | Guid | no |
CustomerId | Guid | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-vendor-disbursement-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.
accountingEntryIdamountcurrencyNumbercustomerIddisbursementDateexchangeRateexternalVendorAccountIdidinternalVendorAccountIdisCancelloanIdpaymentTypePermitted values — validated against the vendor_disbursement_payment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Kredi Ödemesi | en: Loan Payment · tr: Kredi Ödemesi · ar: سداد القرض |
2 | Avans Ödemesi | en: Advance Payment · tr: Avans Ödemesi · ar: الدفع المسبق |
statusPermitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
update-vendor-disbursement-disbursement-date
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
externalTransactionidupdate-vendor-disbursement-disbursement-date › Request Body
disbursementDateupdate-vendor-disbursement-disbursement-date › 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-vendor-disbursement-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<BaseVendorDisbursementDto>.
| Field | Declared type | Nullable |
|---|---|---|
InternalVendorAccountId | Guid? | yes |
ExternalVendorAccountId | Guid? | yes |
DisbursementDate | DateTime? | yes |
Amount | decimal | no |
CurrencyNumber | string | no |
ExchangeRate | decimal? | yes |
IsCancel | bool | no |
Status | int | no |
PaymentType | int | no |
AccountingEntryId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-loan-vendor-disbursement-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.
accountingEntryIdamountcurrencyNumberdisbursementDateexchangeRateexternalVendorAccountIdidinternalVendorAccountIdisCancelpaymentTypePermitted values — validated against the vendor_disbursement_payment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Kredi Ödemesi | en: Loan Payment · tr: Kredi Ödemesi · ar: سداد القرض |
2 | Avans Ödemesi | en: Advance Payment · tr: Avans Ödemesi · ar: الدفع المسبق |
statusPermitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
create-vendor-disbursement
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_10 | 400 | VENDOR_EXTERNAL_ACCOUNT_NOT_FOUND | Account cannot be found. :{0} |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_19 | 400 | LOAN_VENDOR_DISBURSEMENT_AMOUNT_CONTROL | The total vendor disbursement amount cannot be greater than the loan amount. |
ERR_LOAN_21 | 400 | CURRENCY_NUMBER_MUST_NOT_BE_EQUAL | The currency of the account is not equal |
ERR_LOAN_4 | 400 | VENDOR_INTERNAL_ACCOUNT_NOT_FOUND | Account record cannot be found. :{0} |
path Parameters
idcreate-vendor-disbursement › Request Body
amountcurrencyNumberexchangeRatepaymentTypePermitted values — validated against the vendor_disbursement_payment_type parameter.
| Value | Meaning |
|---|---|
1 | Loan Payment |
2 | Advance Payment |
Permitted values — validated against the vendor_disbursement_payment_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Kredi Ödemesi | en: Loan Payment · tr: Kredi Ödemesi · ar: سداد القرض |
2 | Avans Ödemesi | en: Advance Payment · tr: Avans Ödemesi · ar: الدفع المسبق |
disbursementDateexternalVendorAccountIdinternalVendorAccountIdcreate-vendor-disbursement › 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-vendor-disbursement-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 VendorDisbursementDto.
| Field | Declared type | Nullable |
|---|---|---|
InternalVendorId | Guid? | yes |
ExternalVendorId | Guid? | yes |
LoanId | Guid | no |
CustomerId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_22 | 400 | LOAN_VENDOR_DISBURSEMENT_MUST_NOT_BE_NULL | Vendor disbursement cannot be found.:{0} |
path Parameters
idvendorDisbursementIdget-vendor-disbursement-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-vendor-disbursement-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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_22 | 400 | LOAN_VENDOR_DISBURSEMENT_MUST_NOT_BE_NULL | Vendor disbursement cannot be found.:{0} |
path Parameters
idvendorDisbursementIdupdate-vendor-disbursement-accounting-entry-id › Request Body
accountingEntryIdupdate-vendor-disbursement-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-vendor-disbursement
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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_22 | 400 | LOAN_VENDOR_DISBURSEMENT_MUST_NOT_BE_NULL | Vendor disbursement cannot be found.:{0} |
ERR_LOAN_28 | 400 | LOAN_VENDOR_DISBURSEMENT_STATUS_MUST_NOT_BE_CANCEL | The vendor payment has already been cancelled. |
path Parameters
idvendorDisbursementIdcancel-vendor-disbursement › 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-vendor-disbursement-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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_22 | 400 | LOAN_VENDOR_DISBURSEMENT_MUST_NOT_BE_NULL | Vendor disbursement cannot be found.:{0} |
path Parameters
idvendorDisbursementIdupdate-vendor-disbursement-status › Request Body
statusPermitted values — validated against the vendor_disbursement_status parameter.
| Value | Meaning |
|---|---|
1 | Pending Money Transfer |
2 | Completed |
Permitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
update-vendor-disbursement-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.