ROSE Developers - Web API Reference

Taxes | Withholding Tax Posting

The Withholding Tax Postings end point is used to obtain a list of withholding tax postings.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET WTaxPostings

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See WTaxPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /taxesCore/wTaxPostings

GET WTaxPostings (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 WTaxPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /taxesCore/wTaxPostings?page={page}&pageSize={pageSize}

GET WTaxPosting 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 WTaxPostingResource.

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 /taxesCore/wTaxPostings/{id}

GET WTaxPosting by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
wTaxPostingKey (int) The withholding tax's posting key.

Response:

When successful, the response body contains the entity record. See WTaxPostingResource.

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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}

GET Print WTaxPosting 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 /taxesCore/wTaxPostings/{id}/print?template={template}

GET Print WTaxPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
wTaxPostingKey (int) The withholding tax's posting 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/print

GET Original Print WTaxPostingOriginal 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 /taxesCore/wTaxPostings/{id}/printOriginal?template={template}

GET Original Print WTaxPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
wTaxPostingKey (int) The withholding tax's posting 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/printOriginal

POST Operations

POST WTaxPostings

Creates a new entity record.

The following elements are required:

wTaxPostingResource (ApiWTaxPostingResource) The request body should contain the entity record that should be created.
See ApiWTaxPostingResource.

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 ApiWTaxPostingResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /taxesCore/wTaxPostings

PUT Operations

PUT Set Company WTaxPosting

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/company

PUT Set CompanyTaxId WTaxPosting

Updates the value of attribute 'CompanyTaxId' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/companyTaxId

PUT Set Country WTaxPosting

Updates the value of attribute 'Country' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/country

PUT Set Currency WTaxPosting

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/currency

PUT Set DocumentDate WTaxPosting

Updates the value of attribute 'DocumentDate' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (DateTime) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/documentDate

PUT Set ExchangeRate WTaxPosting

Updates the value of attribute 'ExchangeRate' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (decimal) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/exchangeRate

PUT Set ExchangeRateDate WTaxPosting

Updates the value of attribute 'ExchangeRateDate' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (DateTime) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/exchangeRateDate

PUT Set FinancialAccountPostingId WTaxPosting

Updates the value of attribute 'FinancialAccountPostingId' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (Guid) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/financialAccountPostingId

PUT Set IsActive WTaxPosting

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/isActive

PUT Set Percentage WTaxPosting

Updates the value of attribute 'Percentage' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (decimal) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/percentage

PUT Set PostingDate WTaxPosting

Updates the value of attribute 'PostingDate' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (DateTime) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/postingDate

PUT Set SourceDoc WTaxPosting

Updates the value of attribute 'SourceDoc' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/sourceDoc

PUT Set SourceDocId WTaxPosting

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (Guid) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/sourceDocId

PUT Set SourceSchemaEntity WTaxPosting

Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/sourceSchemaEntity

PUT Set TaxableAmount WTaxPosting

Updates the value of attribute 'TaxableAmount' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (decimal) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/taxableAmount

PUT Set TaxOfficeParty WTaxPosting

Updates the value of attribute 'TaxOfficeParty' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/taxOfficeParty

PUT Set WithholdingNature WTaxPosting

Updates the value of attribute 'WithholdingNature' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (enum WithholdingNature) The request body should contain the new value for the attribute.
See WithholdingNature.

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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/withholdingNature

PUT Set WithholdingTaxAmount WTaxPosting

Updates the value of attribute 'WithholdingTaxAmount' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (decimal) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/withholdingTaxAmount

PUT Set WithholdingTaxCode WTaxPosting

Updates the value of attribute 'WithholdingTaxCode' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/withholdingTaxCode

PUT Set WithholdingTaxType WTaxPosting

Updates the value of attribute 'WithholdingTaxType' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/withholdingTaxType

PUT Set WithholdParty WTaxPosting

Updates the value of attribute 'WithholdParty' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/withholdParty

PUT Set WTaxPostingKey WTaxPosting

Updates the value of attribute 'WTaxPostingKey' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company key.
value (int) 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/wTaxPostingKey

PUT Set WTaxSummary WTaxPosting

Updates the value of attribute 'WTaxSummary' in the specified entity record.

The following elements are required:

wTaxPostingKey (int) The withholding tax's posting key.
companyKey (string) The company 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 /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}/wTaxSummary

DELETE Operations

DELETE WTaxPosting 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 /taxesCore/wTaxPostings/{id}

DELETE WTaxPosting by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
wTaxPostingKey (int) The withholding tax's posting 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:

DELETE /taxesCore/wTaxPostings/{companyKey}/{wTaxPostingKey}

Resources


ApiWTaxPostingResource

The following elements are required:

taxableAmount (MoneyResource) The taxable amount.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The withholding tax's amount.
See MoneyResource .
percentage (decimal) The withholding tax's percentage.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
wTaxPostingKey (int) The withholding tax's posting key.
documentDate (DateTime) Data da transação original.
postingDate (DateTime) The date when the document is created.
sourceDoc (string) The source document.
sourceDocId (Guid) The source document's identifier.
withholdParty (string) The withholding party's identifier.
withholdingTaxCode (string) The withholding tax's code.
withholdingTaxType (string) The withholding tax's type.
currency (string) The money's unit.
country (string) The country.
sourceSchemaEntity (string) The source schema's entity.
company (string) The company.
taxOfficeParty (string) The tax office party assigned to the withhoding tax type code.

The following elements are optional:

exchangeRateDate (DateTime) The exchange rate's creation date.
companyTaxId (string) The company's tax identifier.
financialAccountPostingId (Guid) The financial account posting identifier.
withholdingNature (enum WithholdingNature) The withholding tax's nature,.
See WithholdingNature.
wTaxSummary (string) The withholding tax's summary.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



WTaxPostingResource

The following elements are required:

taxableAmount (MoneyResource) The taxable amount.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The withholding tax's amount.
See MoneyResource .
percentage (decimal) The withholding tax's percentage.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
wTaxPostingKey (int) The withholding tax's posting key.
documentDate (DateTime) Data da transação original.
postingDate (DateTime) The date when the document is created.
sourceDoc (string) The source document.
sourceDocId (Guid) The source document's identifier.
withholdParty (string) The withholding party's identifier.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
withholdingTaxCode (string) The withholding tax's code.
(fk) Allowed value: the natural key of a record of type WithholdingTaxCode. These records are accessibly through the WithholdingTaxCodes service.
withholdingTaxType (string) The withholding tax's type.
(fk) Allowed value: the natural key of a record of type WithholdingTaxType. These records are accessibly through the WithholdingTaxTypes service.
currency (string) The money's unit.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
country (string) The country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
sourceSchemaEntity (string) The source schema's entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
company (string) The company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
taxOfficeParty (string) The tax office party assigned to the withhoding tax type code.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.

The following elements are optional:

exchangeRateDate (DateTime) The exchange rate's creation date.
companyTaxId (string) The company's tax identifier.
financialAccountPostingId (Guid) The financial account posting identifier.
withholdingNature (enum WithholdingNature) The withholding tax's nature,.
See WithholdingNature.
wTaxSummary (string) The withholding tax's summary.
(fk) Allowed value: the natural key of a record of type WTaxSummary. These records are accessibly through the WTaxSummaries service.


Enumerations


WithholdingNature

1 Payable
2 Receivable