Operations addressed under /taxes — 13 operations.
get-tax-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<TaxDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
FromProperty | string | no |
TaxCondition | int | no |
Type | int | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-tax-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.
codefromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
idnameratetaxConditionPermitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
create-tax-definition
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 |
|---|---|
ERR_TX_1 | 400 |
create-tax-definition › Request Body
codefromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
nametaxConditionPermitted values — validated against the tax_condition parameter.
| Value | Meaning |
|---|---|
1 | include |
2 | exclude |
Permitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter.
| Value | Meaning |
|---|---|
1 | BSMV |
2 | KDV |
3 | KKDF |
Permitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
create-tax-definition › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-tax-by-code
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 TaxDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
FromProperty | string | no |
TaxCondition | int | no |
Type | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
path Parameters
codeget-tax-by-code › 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.
codefromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
idnameratetaxConditionPermitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
get-tax-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 TaxDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
FromProperty | string | no |
TaxCondition | int | no |
Type | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status |
|---|---|
ERR_TX_2 | 400 |
path Parameters
idget-tax-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.
codefromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
idnameratetaxConditionPermitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
update-tax-definition
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 |
|---|---|
ERR_TX_2 | 400 |
path Parameters
idupdate-tax-definition › Request Body
fromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
nametaxConditionPermitted values — validated against the tax_condition parameter.
| Value | Meaning |
|---|---|
1 | include |
2 | exclude |
Permitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter.
| Value | Meaning |
|---|---|
1 | BSMV |
2 | KDV |
3 | KKDF |
Permitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
update-tax-definition › 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-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 |
|---|---|
ERR_TX_2 | 400 |
path Parameters
iddelete-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-tax-available-rate
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 TaxAvailableRateDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
FromProperty | string | no |
TaxCondition | int | no |
Type | int | no |
TaxRateId | Guid | no |
ValidityBeginDate | DateOnly? | yes |
ValidityEndDate | DateOnly? | yes |
Rate | decimal? | yes |
MinimumAmount | decimal? | yes |
MaximumAmount | decimal? | yes |
FixedAmount | decimal? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
ERR_TX_3 | 400 | TAX_RATE_NOT_FOUND |
path Parameters
idquery Parameters
transactionAmounttransactionDateget-tax-available-rate › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-tax-detail
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 TaxDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
FromProperty | string | no |
TaxCondition | int | no |
Type | int | no |
TaxRates | List<TaxRateDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
path Parameters
idget-tax-detail › 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.
codefromPropertyPermitted values — validated against the from_property parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
2 | principalAmount | no label seeded |
idnametaxConditionPermitted values — validated against the tax_condition parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | include | no label seeded |
2 | exclude | no label seeded |
typePermitted values — validated against the tax_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | BSMV | no label seeded |
2 | KDV | no label seeded |
3 | KKDF | no label seeded |
get-tax-rate-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<TaxRateDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ValidityBeginDate | DateOnly? | yes |
ValidityEndDate | DateOnly? | yes |
Rate | decimal? | yes |
MinimumAmount | decimal? | yes |
MaximumAmount | decimal? | yes |
FixedAmount | decimal? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-tax-rate-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.
fixedAmountidmaximumAmountminimumAmountratevalidityBeginDatevalidityEndDatecreate-tax-rate
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 |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
ERR_TX_6 | 400 | TAX_RATE_DEFINITIN_EXIST_BY_DATE_RANGE_OR_SIMILAR_AMOUNT_RANGE |
path Parameters
idcreate-tax-rate › Request Body
maximumAmountminimumAmountvalidityBeginDatevalidityEndDatefixedAmountratecreate-tax-rate › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-tax-rate-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 TaxRateDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ValidityBeginDate | DateOnly? | yes |
ValidityEndDate | DateOnly? | yes |
Rate | decimal? | yes |
MinimumAmount | decimal? | yes |
MaximumAmount | decimal? | yes |
FixedAmount | decimal? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
ERR_TX_3 | 400 | TAX_RATE_NOT_FOUND |
path Parameters
idtaxRateIdget-tax-rate-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.
fixedAmountidmaximumAmountminimumAmountratevalidityBeginDatevalidityEndDatedelete-tax-rate
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 |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
ERR_TX_3 | 400 | TAX_RATE_NOT_FOUND |
ERR_TX_8 | 400 | TAX_RATE_VALIDITY_BEGIN_DATE_IS_PAST |
path Parameters
idtaxRateIddelete-tax-rate › 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-tax-rate-validity-date
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 |
|---|---|---|
ERR_TX_2 | 400 | TAX_NOT_FOUND |
ERR_TX_3 | 400 | TAX_RATE_NOT_FOUND |
ERR_TX_6 | 400 | TAX_RATE_DEFINITIN_EXIST_BY_DATE_RANGE_OR_SIMILAR_AMOUNT_RANGE |
path Parameters
idtaxRateIdupdate-tax-rate-validity-date › Request Body
validityBeginDatevalidityEndDateupdate-tax-rate-validity-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.