ROSE Developers - Web API Reference

Taxes | Withholding Tax Summary

The Withholding Tax Summaries end point is used to get a list of withholding tax summaries. Such as amounts and source document information.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/wTaxSummaries
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 WTaxSummaries

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/wTaxSummaries

GET WTaxSummaries (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 WTaxSummaryResource.

Response status codes:

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

Resource URL:

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

GET WTaxSummary 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 WTaxSummaryResource.

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

GET WTaxSummary by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
wTaxSummaryKey (int) The withholding tax's summary key.

Response:

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

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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}

GET Print WTaxSummary 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/wTaxSummaries/{id}/print?template={template}

GET Print WTaxSummary by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/print

GET Original Print WTaxSummaryOriginal 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/wTaxSummaries/{id}/printOriginal?template={template}

GET Original Print WTaxSummary by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/printOriginal

POST Operations

POST WTaxSummaries

Creates a new entity record.

The following elements are required:

wTaxSummaryResource (ApiWTaxSummaryResource) The request body should contain the entity record that should be created.
See ApiWTaxSummaryResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/wTaxSummaries

PUT Operations

PUT Set Company WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/company

PUT Set CompanyTaxId WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/companyTaxId

PUT Set Country WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/country

PUT Set Currency WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/currency

PUT Set DocumentDate WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/documentDate

PUT Set ExchangeRate WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/exchangeRate

PUT Set ExchangeRateDate WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/exchangeRateDate

PUT Set IsActive WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/isActive

PUT Set OpenTaxableAmount WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/openTaxableAmount

PUT Set OpenWithholdingTaxAmount WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/openWithholdingTaxAmount

PUT Set Percentage WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/percentage

PUT Set PostingDate WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/postingDate

PUT Set SourceDoc WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/sourceDoc

PUT Set SourceDocId WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/sourceDocId

PUT Set SourceDocLineId WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/sourceDocLineId

PUT Set SourceDocLineNumber WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/sourceDocLineNumber

PUT Set SourceSchemaEntity WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/sourceSchemaEntity

PUT Set TaxableAmount WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/taxableAmount

PUT Set TaxOfficeParty WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/taxOfficeParty

PUT Set WithholdingNature WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/withholdingNature

PUT Set WithholdingTaxAmount WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/withholdingTaxAmount

PUT Set WithholdingTaxCode WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/withholdingTaxCode

PUT Set WithholdingTaxType WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/withholdingTaxType

PUT Set WithholdParty WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/withholdParty

PUT Set WTaxSummaryKey WTaxSummary

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

The following elements are required:

wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}/wTaxSummaryKey

DELETE Operations

DELETE WTaxSummary 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/wTaxSummaries/{id}

DELETE WTaxSummary by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
wTaxSummaryKey (int) The withholding tax's summary 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/wTaxSummaries/{companyKey}/{wTaxSummaryKey}

Resources


ApiWTaxSummaryResource

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.
wTaxSummaryKey (int) The withholding tax's summary 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.
openWithholdingTaxAmount (MoneyResource) The open withholding tax's amount.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount.
See MoneyResource .
withholdParty (string) The withholding party's identifier.
withholdingTaxCode (string) The withholding tax's code.
currency (string) The money's unit.
company (string) The company key.
country (string) The country.
sourceSchemaEntity (string) The source schema's entity.
withholdingTaxType (string) The withholding tax's type.
taxOfficeParty (string) Tax Office Party(ex: AT).

The following elements are optional:

exchangeRateDate (DateTime) The exchange rate's creation date.
companyTaxId (string) The company tax's identifier.
withholdingNature (enum WithholdingNature) The withholding tax's nature,.
See WithholdingNature.
sourceDocLineId (Guid) Id of sourcedocline.
sourceDocLineNumber (int) Number of source doc line.


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.



WTaxSummaryResource

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.
wTaxSummaryKey (int) The withholding tax's summary 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.
openWithholdingTaxAmount (MoneyResource) The open withholding tax's amount.
See MoneyResource .
openTaxableAmount (MoneyResource) The open taxable amount.
See MoneyResource .
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.
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.
company (string) The company key.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies 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.
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.
taxOfficeParty (string) Tax Office Party(ex: AT).
(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 tax's identifier.
withholdingNature (enum WithholdingNature) The withholding tax's nature,.
See WithholdingNature.
sourceDocLineId (Guid) Id of sourcedocline.
sourceDocLineNumber (int) Number of source doc line.


Enumerations


WithholdingNature

1 Payable
2 Receivable