ROSE Developers - Web API Reference

Taxes | Income Withholdings Report

Service to manage entities of type 'IncomeWithholdingsReport'.

Overview


URL api/{tenantKey}/{orgKey}/taxAuthorityPT/incomeWithholdingsReports
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 IncomeWithholdingsReports

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxAuthorityPT/incomeWithholdingsReports

GET IncomeWithholdingsReports (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 IncomeWithholdingsReportResource.

Response status codes:

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

Resource URL:

GET /taxAuthorityPT/incomeWithholdingsReports?page={page}&pageSize={pageSize}

GET IncomeWithholdingsReport 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 IncomeWithholdingsReportResource.

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

GET IncomeWithholdingsReport by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
reportKey (string) Report.

Response:

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

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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}

GET Print IncomeWithholdingsReport 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 /taxAuthorityPT/incomeWithholdingsReports/{id}/print?template={template}

GET Print IncomeWithholdingsReport by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
reportKey (string) Report.

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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/print

GET Original Print IncomeWithholdingsReportOriginal 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 /taxAuthorityPT/incomeWithholdingsReports/{id}/printOriginal?template={template}

GET Original Print IncomeWithholdingsReport by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
reportKey (string) Report.

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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/printOriginal

POST Operations

POST IncomeWithholdingsReports

Creates a new entity record.

The following elements are required:

incomeWithholdingsReportResource (ApiIncomeWithholdingsReportResource) The request body should contain the entity record that should be created.
See ApiIncomeWithholdingsReportResource.

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

Response status codes:

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

Resource URL:

POST /taxAuthorityPT/incomeWithholdingsReports

PUT Operations

PUT Set AccountantTaxId IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/accountantTaxId

PUT Set Company IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/company

PUT Set Currency IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/currency

PUT Set FinanceServiceCode IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/financeServiceCode

PUT Set IsActive IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/isActive

PUT Set IsPrinted IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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.

Resource URL:

PUT /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/isPrinted

PUT Set IsReprinted IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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.

Resource URL:

PUT /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/isReprinted

PUT Set IsSigned IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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.

Resource URL:

PUT /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/isSigned

PUT Set LegalRepresentativeTaxId IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/legalRepresentativeTaxId

PUT Set PrintedReportName IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/printedReportName

PUT Set ReportKey IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/reportKey

PUT Set WithholdingTaxTotal IncomeWithholdingsReport

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

The following elements are required:

reportKey (string) Report.
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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}/withholdingTaxTotal

DELETE Operations

DELETE IncomeWithholdingsReport 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 /taxAuthorityPT/incomeWithholdingsReports/{id}

DELETE IncomeWithholdingsReport by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
reportKey (string) Report.

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 /taxAuthorityPT/incomeWithholdingsReports/{companyKey}/{reportKey}

Resources


ApiIncomeWithholdingsReportResource

The following elements are required:

reportKey (string) Report.
company (string) Company.
currency (string) Currency.
date (DateTime) Date.
year (int) Year.
type (enum IncomeWithholdingsReportType) Type.
See IncomeWithholdingsReportType.
withholdingTaxTotal (MoneyResource) Total.
See MoneyResource .
companyTaxId (string) Company Tax Id.
accountantTaxId (string) Accountant Tax Id.
legalRepresentativeTaxId (string) Legal Representative Tax Id.
financeServiceCode (string) Authority Service Code.

The following elements are optional:

substituteDate (DateTime) Substitute Date.
printedReportName (string) Printed Report Name.
isPrinted (bool) Is Printed.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


IncomeWithholdingsReportResource

The following elements are required:

reportKey (string) Report.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
date (DateTime) Date.
year (int) Year.
type (enum IncomeWithholdingsReportType) Type.
See IncomeWithholdingsReportType.
withholdingTaxTotal (MoneyResource) Total.
See MoneyResource .
companyTaxId (string) Company Tax Id.
accountantTaxId (string) Accountant Tax Id.
legalRepresentativeTaxId (string) Legal Representative Tax Id.
financeServiceCode (string) Authority Service Code.

The following elements are optional:

substituteDate (DateTime) Substitute Date.
printedReportName (string) Printed Report Name.
isPrinted (bool) Is Printed.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


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.



Enumerations


IncomeWithholdingsReportType

1 First
2 Substitute
3 Resubmission