Taxes | Party Tax Schema
Service to manage entities of type 'PartyTaxSchema'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/partyTaxSchemas |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET PartyTaxSchemas (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See PartyTaxSchemaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PartyTaxSchema by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See PartyTaxSchemaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET PartyTaxSchema by key
Returns the entity record that matches the specified key.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
Response:
| When successful, the response body contains the entity record. See PartyTaxSchemaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST PartyTaxSchemas
Creates a new entity record.
The following elements are required:
| partyTaxSchemaResource | (ApiPartyTaxSchemaResource) The request body should contain the entity record that should be created. See ApiPartyTaxSchemaResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiPartyTaxSchemaResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Tax Regime Codes
Inserts a new 'Tax Regime Codes' in the 'Tax Regime'.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| value | (ApiPartyTaxSchemaPartyTaxSchemaListsResource) The ApiPartyTaxSchemaPartyTaxSchemaListsResource instance. See ApiPartyTaxSchemaPartyTaxSchemaListsResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AllowedIn PartyTaxSchema
Updates the value of attribute 'AllowedIn' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| value | (enum AllowedIn) The request body should contain the new value for the attribute. See AllowedIn. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description PartyTaxSchema
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExemptionReasonCode PartyTaxSchemaList
Updates the value of attribute 'ExemptionReasonCode' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive PartyTaxSchema
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsExempt PartyTaxSchemaList
Updates the value of attribute 'IsExempt' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| lineId | (string) The detail identifier. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxCodeGroupKey PartyTaxSchema
Updates the value of attribute 'TaxCodeGroupKey' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxTypeCode PartyTaxSchemaList
Updates the value of attribute 'TaxTypeCode' in the specified entity record.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Tax Regime Codes by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE PartyTaxSchema by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE PartyTaxSchema by key
Deletes the entity record that matches the specified key.
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiPartyTaxSchemaPartyTaxSchemaListsResource
The following elements are required:
| taxTypeCode | (string) The tax's type code. Code that identifies the type of tax applied. |
| isExempt | (bool) Indicates if is exempt or not. Discharge from payment of certain fees based on the fulfillment of certain attributes. |
The following elements are optional:
| exemptionReasonCode | (string) The exemption reason's code. It represents the reason why a specific operation does not pay taxes. |
ApiPartyTaxSchemaResource
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| allowedIn | (enum AllowedIn) Allowed In.
See AllowedIn. |
The following elements are optional:
| description | (string) The party's tax schema description. The tax schema identifies the group of taxes a party is liable for. This group usually depends on the company situation or the head office location. |
| partyTaxSchemaLists | (List of ApiPartyTaxSchemaPartyTaxSchemaListsResource) The list of taxes.
See ApiPartyTaxSchemaPartyTaxSchemaListsResource. |
PartyTaxSchemaResource
The following elements are required:
| taxCodeGroupKey | (string) The party's tax schema key. |
| allowedIn | (enum AllowedIn) Allowed In.
See AllowedIn. |
The following elements are optional:
| description | (string) The party's tax schema description. The tax schema identifies the group of taxes a party is liable for. This group usually depends on the company situation or the head office location. |
| partyTaxSchemaLists | (List of PartyTaxSchemaListResource) The list of taxes.
See PartyTaxSchemaListResource. |