internal-vendors
Operations addressed under /internal-vendors — 10 operations.
get-vendor-internal-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<VendorInternalDto>.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid | no |
InternalVendorNumber | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-vendor-internal-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.
customerIdidinternalVendorNumberisActivecreate-vendor-internal
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 CreateVendorInternalDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
InternalVendorNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_1 | 400 | VENDOR_INTERNAL_HAS_CUSTOMER | This customer has a vendor record. :{0} |
create-vendor-internal › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-vendor-internal-list-details
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<VendorInternalDetailsDto>.
| Field | Declared type | Nullable |
|---|---|---|
Accounts | List<VendorAccountDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-vendor-internal-list-details › 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.
customerIdidinternalVendorNumberisActiveget-vendor-internal-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 VendorInternalDto.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid | no |
InternalVendorNumber | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
idget-vendor-internal-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.
customerIdidinternalVendorNumberisActivedelete-vendor-internal
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_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
iddelete-vendor-internal › 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-vendor-internal-account-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<VendorInternalAccountDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
Iban | string | no |
CurrencyNumber | string | no |
CustomerAccountId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
idget-vendor-internal-account-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.
currencyNumbercustomerAccountIdibanidcreate-vendor-internal-account
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_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
idcreate-vendor-internal-account › 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-vendor-internal-account
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_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
ERR_LOAN_4 | 400 | VENDOR_INTERNAL_ACCOUNT_NOT_FOUND | Account record cannot be found. :{0} |
path Parameters
idvendorAccountIddelete-vendor-internal-account › 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-vendor-internal-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 VendorInternalDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
Accounts | List<VendorAccountDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
idget-vendor-internal-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.
customerIdidinternalVendorNumberisActiveupdate-vendor-internal-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_2 | 400 | VENDOR_INTERNAL_NOT_FOUND | Internal vendor cannot be found. :{0} |
path Parameters
idupdate-vendor-internal-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.