Taxes | Party WHT Schema
Service to manage entities of type 'PartyWithholdingTaxSchema'.
Overview
URL | api/{tenantKey}/{orgKey}/taxesCore/partyWithholdingTaxSchemas |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive PartyWithholdingTaxSchema
- PUT Set PartyWithholdingTaxSchemaKey PartyWithholdingTaxSchema
- PUT Set Description PartyWithholdingTaxSchema
- PUT Set WithholdingTaxCode PartyWithholdingTaxSchemaList
- PUT Set ExemptionReasonCode PartyWithholdingTaxSchemaList
- PUT Set IsExempt PartyWithholdingTaxSchemaList
- DELETE:
All Resources
This service uses the following resources:
GET PartyWithholdingTaxSchemas (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 PartyWithholdingTaxSchemaResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PartyWithholdingTaxSchema 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 PartyWithholdingTaxSchemaResource. |
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 PartyWithholdingTaxSchema by key
Returns the entity record that matches the specified key.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding tax schema key. |
Response:
When successful, the response body contains the entity record. See PartyWithholdingTaxSchemaResource. |
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 PartyWithholdingTaxSchemas
Creates a new entity record.
The following elements are required:
partyWithholdingTaxSchemaResource | (ApiPartyWithholdingTaxSchemaResource) The request body should contain the entity record that should be created. See ApiPartyWithholdingTaxSchemaResource. |
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 ApiPartyWithholdingTaxSchemaResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Withholding Regime Codes
Inserts a new 'Withholding Regime Codes' in the 'Withholding Regime'.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding tax schema key. |
value | (ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource) The ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource instance. See ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource. |
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 Description PartyWithholdingTaxSchema
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 PartyWithholdingTaxSchemaList
Updates the value of attribute 'ExemptionReasonCode' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 PartyWithholdingTaxSchema
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 PartyWithholdingTaxSchemaList
Updates the value of attribute 'IsExempt' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 PartyWithholdingTaxSchemaKey PartyWithholdingTaxSchema
Updates the value of attribute 'PartyWithholdingTaxSchemaKey' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 WithholdingTaxCode PartyWithholdingTaxSchemaList
Updates the value of attribute 'WithholdingTaxCode' in the specified entity record.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 Withholding Regime Codes by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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 PartyWithholdingTaxSchema 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 PartyWithholdingTaxSchema by key
Deletes the entity record that matches the specified key.
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding 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
ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource
The following elements are required:
withholdingTaxCode | (string) The withholding's tax type code. Code that identifies the type of withholding 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 withholding taxes. |
ApiPartyWithholdingTaxSchemaResource
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding tax schema key. |
The following elements are optional:
description | (string) The party's withholding schema description. The withholding tax schema identifies the group of withholding taxes a party is liable for. |
partyWithholdingTaxSchemaLists | (List of ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource) The list of withholding taxes.
See ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource. |
PartyWithholdingTaxSchemaResource
The following elements are required:
partyWithholdingTaxSchemaKey | (string) The party's withholding tax schema key. |
The following elements are optional:
description | (string) The party's withholding schema description. The withholding tax schema identifies the group of withholding taxes a party is liable for. |
partyWithholdingTaxSchemaLists | (List of PartyWithholdingTaxSchemaListResource) The list of withholding taxes.
See PartyWithholdingTaxSchemaListResource. |