limit-items
Operations addressed under /limit-items — 19 operations.
get-limit-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<LimitItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
LevelNumber | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-limit-item-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.
codedescriptionidisActivelevelNumbernamecreate-limit-item
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_TRLMT_1 | 400 | LIMIT_ITEM_MUST_BE_NULL | Limit item must be null. |
create-limit-item › Request Body
codedescriptionlevelNumbernamecreate-limit-item › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-limit-control
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 bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TRLMT_14 | 400 | LIMIT_ITEM_SERVICE_MAP_MUST_NOT_BE_NULL | Limit item service map can not be null. |
ERR_TRLMT_18 | 400 | AMOUNT_LESS_THAN_DEFINED_MIN_LIMIT | Transaction amount is less than minimum amount. |
ERR_TRLMT_19 | 400 | AMOUNT_HIGHER_THAN_DEFINED_MAX_LIMIT | Transaction amount is higher than maximum amount. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_22 | 400 | ACCOUNT_INFO_NOT_FOUND | Account info cannot be found. |
ERR_TRLMT_23 | 400 | CUSTOMER_INFO_NOT_FOUND | Customer info cannot be found. |
ERR_TRLMT_24 | 400 | SERVICE_DEFINITION_NOT_FOUND | Service definition cannot be found. |
ERR_TRLMT_5 | 400 | CURRENCY_NUMBER_MUST_BE_VALID | Currency Number not valid. |
ERR_TRLMT_8 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_NULL_OR_EMPTY | Limit item dimension can not be null. |
query Parameters
accountIdcurrencyNumbercustomerIdserviceDefinitionIdtransactionAmountget-limit-control › 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-limit-item-dimension-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<LimitItemDimensionDto>.
| Field | Declared type | Nullable |
|---|---|---|
LimitItemId | Guid | no |
Period | int | no |
CustomerType | int | no |
CurrencyNumber | string | no |
LimitAmount | decimal | no |
LimitCount | int | no |
LimitMaxAmount | decimal? | yes |
LimitMinAmount | decimal? | yes |
IsActive | bool | no |
CustomerId | Guid? | yes |
IsDefault | bool | no |
StartDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-limit-item-dimension-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.
currencyNumbercustomerClasscustomerIdendDateidisActiveisDefaultlimitAmountlimitCountlimitItemIdlimitMaxAmountlimitMinAmountperiodPermitted values — validated against the period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Day | en: Day · tr: Gün · ar: يوم |
2 | Week | en: Week · tr: Hafta · ar: أسبوع |
3 | Month | en: Month · tr: Month · ar: شهر |
4 | Year | en: Year · tr: Yıl · ar: سنة |
startDateget-limit-item-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 LimitItemDto.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
LevelNumber | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
path Parameters
idget-limit-item-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.
codedescriptionidisActivelevelNumbernameupdate-limit-item
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idupdate-limit-item › Request Body
descriptionisActivelevelNumbernameupdate-limit-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-limit-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_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
iddelete-limit-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-limit-item-dimension-list-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the get-limit-item-dimension-list-by-id service definition through GET /limit-items/{id}/dimensions.
Response body, read from the service source
The route declares its response as IEnumerable<LimitItemDimensionDto>.
| Field | Declared type | Nullable |
|---|---|---|
LimitItemId | Guid | no |
Period | int | no |
CustomerType | int | no |
CurrencyNumber | string | no |
LimitAmount | decimal | no |
LimitCount | int | no |
LimitMaxAmount | decimal? | yes |
LimitMinAmount | decimal? | yes |
IsActive | bool | no |
CustomerId | Guid? | yes |
IsDefault | bool | no |
StartDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-limit-item-dimension-list-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-limit-item-dimension
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_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_23 | 400 | CUSTOMER_INFO_NOT_FOUND | Customer info cannot be found. |
ERR_TRLMT_26 | 400 | IS_DEFAULT_TRUE_CUSTOMER_MUST_BE_NULL | Customer info must be null for default dimension definition. |
ERR_TRLMT_27 | 400 | IS_START_DATE_HAS_VALUE_END_DATE_ALSO_HAS_VALUE | End date must not be null. |
ERR_TRLMT_28 | 400 | IS_END_DATE_HAS_VALUE_START_DATE_ALSO_HAS_VALUE | Start date must not be null. |
ERR_TRLMT_3 | 400 | LIMIT_ITEM_MUST_NOT_BE_PASSIVE | Limit item must be active. |
ERR_TRLMT_4 | 400 | LIMIT_ITEM_MUST_BE_UNIQ | Limit item must be unique. |
ERR_TRLMT_5 | 400 | CURRENCY_NUMBER_MUST_BE_VALID | Currency Number not valid. |
path Parameters
idcreate-limit-item-dimension › Request Body
currencyNumberisDefaultlimitAmountlimitCountlimitMaxAmountlimitMinAmountperiodPermitted values — validated against the period parameter.
| Value | Meaning |
|---|---|
1 | Day |
2 | Week |
3 | Month |
4 | Year |
Permitted values — validated against the period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Day | en: Day · tr: Gün · ar: يوم |
2 | Week | en: Week · tr: Hafta · ar: أسبوع |
3 | Month | en: Month · tr: Month · ar: شهر |
4 | Year | en: Year · tr: Yıl · ar: سنة |
customerIdcustomerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | ar: فرد |
2 | Corporate | ar: شركة |
endDatestartDatecreate-limit-item-dimension › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-limit-item-dimension-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the get-limit-item-dimension-by-id service definition through GET /limit-items/{id}/dimensions/{limitItemDimensionId}.
Response body, read from the service source
The route declares its response as LimitItemDimensionDto.
| Field | Declared type | Nullable |
|---|---|---|
LimitItemId | Guid | no |
Period | int | no |
CustomerType | int | no |
CurrencyNumber | string | no |
LimitAmount | decimal | no |
LimitCount | int | no |
LimitMaxAmount | decimal? | yes |
LimitMinAmount | decimal? | yes |
IsActive | bool | no |
CustomerId | Guid? | yes |
IsDefault | bool | no |
StartDate | DateOnly? | yes |
EndDate | DateOnly? | yes |
Member names are the service's declaration names.
path Parameters
idlimitItemDimensionIdget-limit-item-dimension-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-limit-item-dimension
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_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_23 | 400 | CUSTOMER_INFO_NOT_FOUND | Customer info cannot be found. |
ERR_TRLMT_26 | 400 | IS_DEFAULT_TRUE_CUSTOMER_MUST_BE_NULL | Customer info must be null for default dimension definition. |
ERR_TRLMT_27 | 400 | IS_START_DATE_HAS_VALUE_END_DATE_ALSO_HAS_VALUE | End date must not be null. |
ERR_TRLMT_28 | 400 | IS_END_DATE_HAS_VALUE_START_DATE_ALSO_HAS_VALUE | Start date must not be null. |
ERR_TRLMT_3 | 400 | LIMIT_ITEM_MUST_NOT_BE_PASSIVE | Limit item must be active. |
ERR_TRLMT_5 | 400 | CURRENCY_NUMBER_MUST_BE_VALID | Currency Number not valid. |
ERR_TRLMT_8 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_NULL_OR_EMPTY | Limit item dimension can not be null. |
path Parameters
idlimitItemDimensionIdupdate-limit-item-dimension › Request Body
currencyNumberisActiveisDefaultlimitAmountlimitCountlimitMaxAmountlimitMinAmountperiodPermitted values — validated against the period parameter.
| Value | Meaning |
|---|---|
1 | Day |
2 | Week |
3 | Month |
4 | Year |
Permitted values — validated against the period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Day | en: Day · tr: Gün · ar: يوم |
2 | Week | en: Week · tr: Hafta · ar: أسبوع |
3 | Month | en: Month · tr: Month · ar: شهر |
4 | Year | en: Year · tr: Yıl · ar: سنة |
customerIdcustomerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | ar: فرد |
2 | Corporate | ar: شركة |
endDatestartDateupdate-limit-item-dimension › 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-limit-item-dimension
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-limit-item-dimension service definition through DELETE /limit-items/{id}/dimensions/{limitItemDimensionId}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_8 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_NULL_OR_EMPTY | Limit item dimension can not be null. |
path Parameters
idlimitItemDimensionIddelete-limit-item-dimension › 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-limit-item-schedule
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_TRLMT_10 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_PASSIVE | Limit item dimension can not be passive. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_3 | 400 | LIMIT_ITEM_MUST_NOT_BE_PASSIVE | Limit item must be active. |
ERR_TRLMT_8 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_NULL_OR_EMPTY | Limit item dimension can not be null. |
ERR_TRLMT_9 | 400 | LIMIT_ITEM_SCHEDULE_MUST_NOT_BE_NULL_OR_EMPTY | Limit item schedule can not be null. |
path Parameters
idlimitItemDimensionIdcreate-limit-item-schedule › Request Body
beginHolidaybeginWeekDayendHolidayendWeekDaycreate-limit-item-schedule › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
delete-limit-item-schedule
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the delete-limit-item-schedule service definition through DELETE /limit-items/{id}/dimensions/{limitItemDimensionId}/schedules/{limitItemScheduleId}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TRLMT_10 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_PASSIVE | Limit item dimension can not be passive. |
ERR_TRLMT_11 | 400 | LIMIT_ITEM_SCHEDULE_MUST_NOT_BE_NULL | Limit item schedule can not be null. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
ERR_TRLMT_3 | 400 | LIMIT_ITEM_MUST_NOT_BE_PASSIVE | Limit item must be active. |
ERR_TRLMT_8 | 400 | LIMIT_ITEM_DIMENSION_MUST_NOT_BE_NULL_OR_EMPTY | Limit item dimension can not be null. |
path Parameters
idlimitItemDimensionIdlimitItemScheduleIddelete-limit-item-schedule › 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-limit-item-service-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<LimitItemServiceMapDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
LimitItemId | Guid | no |
ServiceDefinitionId | Guid | no |
IsActive | bool | no |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-limit-item-service-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.
idisActivelimitItemIdserviceDefinitionIdcreate-limit-item-service-map
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_TRLMT_13 | 400 | LIMIT_ITEM_SERVICE_MAP_MUST_BE_UNIQ | Limit item service map not unique. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
idcreate-limit-item-service-map › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-limit-item-service-map-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 LimitItemServiceMapDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
LimitItemId | Guid | no |
ServiceDefinitionId | Guid | 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_TRLMT_14 | 400 | LIMIT_ITEM_SERVICE_MAP_MUST_NOT_BE_NULL | Limit item service map can not be null. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
idlimitItemServiceMapIdget-limit-item-service-map-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.
isActivelimitItemIdserviceDefinitionIdupdate-limit-item-service-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_TRLMT_14 | 400 | LIMIT_ITEM_SERVICE_MAP_MUST_NOT_BE_NULL | Limit item service map can not be null. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
idlimitItemServiceMapIdupdate-limit-item-service-map › Request Body
isActiveserviceDefinitionIdupdate-limit-item-service-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-limit-item-service-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_TRLMT_14 | 400 | LIMIT_ITEM_SERVICE_MAP_MUST_NOT_BE_NULL | Limit item service map can not be null. |
ERR_TRLMT_2 | 400 | LIMIT_ITEM_MUST_NOT_BE_NULL | Limit item must not be null. |
path Parameters
idlimitItemServiceMapIddelete-limit-item-service-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.