Taxes | Party WHT Schema

The Party Withholding Tax Schema represents a withholding tax aggregation and is associated with the party.

Overview

URL	api/{tenantKey}/{orgKey}/taxesCore/partyWithholdingTaxSchemas
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET PartyWithholdingTaxSchemas
  • GET PartyWithholdingTaxSchemas (paged)
  • GET PartyWithholdingTaxSchema by identifier
  • GET PartyWithholdingTaxSchema by key
  • GET Print PartyWithholdingTaxSchema by identifier
  • GET Print PartyWithholdingTaxSchema by key
  • GET Original Print PartyWithholdingTaxSchemaOriginal by identifier
  • GET Original Print PartyWithholdingTaxSchema by key
• POST:
  • POST PartyWithholdingTaxSchemas
  • POST Withholding Tax Regime
• PUT:
  • PUT Set Custom Attribute PartyWithholdingTaxSchema
  • PUT Set Custom Attribute PartyWithholdingTaxSchemaList
  • 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:
  • DELETE Party WHT Schema List by identifier
  • DELETE PartyWithholdingTaxSchema by identifier
  • DELETE PartyWithholdingTaxSchema by key

All Resources

This service uses the following resources:

• ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource
• ApiPartyWithholdingTaxSchemaResource
• PartyWithholdingTaxSchemaListResource
• PartyWithholdingTaxSchemaResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET PartyWithholdingTaxSchemas

Returns the list of all the entity records available.

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 PartyWithholdingTaxSchemas (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

GET Print PartyWithholdingTaxSchema by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print PartyWithholdingTaxSchema by key

Prints the specified entity record.

The following elements are required:

partyWithholdingTaxSchemaKey

(string) The party's withholding tax schema key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 Original Print PartyWithholdingTaxSchemaOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print PartyWithholdingTaxSchema by key

Prints the specified entity record.

The following elements are required:

partyWithholdingTaxSchemaKey

(string) The party's withholding tax schema key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 Operations

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.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Tax Regime

Inserts a new 'Party WHT Schema List' in the 'Withholding Tax Regime'.

The following elements are required:

partyWithholdingTaxSchemaKey	(string) The party's withholding tax schema key.
value	(ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource) The ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource instance. See ApiPartyWithholdingTaxSchemaPartyWithholdingTaxSchemaListsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Operations

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:

PUT Set Custom Attribute PartyWithholdingTaxSchema

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

partyWithholdingTaxSchemaKey	(string) The party's withholding tax schema key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Custom Attribute PartyWithholdingTaxSchemaList

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

partyWithholdingTaxSchemaKey	(string) The party's withholding tax schema key.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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:

DELETE Operations

DELETE Party WHT Schema List 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) The IsExempt Flag 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, 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.

PartyWithholdingTaxSchemaListResource

The following elements are required:

withholdingTaxCode	(string) The withholding's tax type code. Code that identifies the type of withholding tax applied.
isExempt	(bool) The IsExempt Flag 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, represents the reason why a specific operation does not pay withholding taxes.

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.