ROSE Developers - Web API Reference

Taxes | Fiscal Witholding Tax Type

The Fiscal WithholdingTaxType represents the fiscal withholding type.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET FiscalWitholdingTaxTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/fiscalWitholdingTaxTypes

GET FiscalWitholdingTaxTypes (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 FiscalWitholdingTaxTypeResource.

Response status codes:

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

Resource URL:

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

GET FiscalWitholdingTaxType 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 FiscalWitholdingTaxTypeResource.

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

GET FiscalWitholdingTaxType by key

Returns the entity record that matches the specified key.

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type key.

Response:

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

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/fiscalWitholdingTaxTypes/{fiscalKey}

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

GET Print FiscalWitholdingTaxType by key

Prints the specified entity record.

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}/print

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

GET Original Print FiscalWitholdingTaxType by key

Prints the specified entity record.

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}/printOriginal

POST Operations

POST FiscalWitholdingTaxTypes

Creates a new entity record.

The following elements are required:

fiscalWitholdingTaxTypeResource (ApiFiscalWitholdingTaxTypeResource) The request body should contain the entity record that should be created.
See ApiFiscalWitholdingTaxTypeResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/fiscalWitholdingTaxTypes

PUT Operations

PUT Set Description FiscalWitholdingTaxType

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

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}/description

PUT Set FiscalKey FiscalWitholdingTaxType

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

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}/fiscalKey

PUT Set IsActive FiscalWitholdingTaxType

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

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}/isActive

PUT Set Custom Attribute FiscalWitholdingTaxType

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

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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 /taxesCore/fiscalWitholdingTaxTypes/{fiscalKey}/{customAttributeName}

DELETE Operations

DELETE FiscalWitholdingTaxType 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/fiscalWitholdingTaxTypes/{id}

DELETE FiscalWitholdingTaxType by key

Deletes the entity record that matches the specified key.

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type 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/fiscalWitholdingTaxTypes/{fiscalKey}

Resources


ApiFiscalWitholdingTaxTypeResource

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type key.

The following elements are optional:

description (string) The fiscal's withholding tax type description.


FiscalWitholdingTaxTypeResource

The following elements are required:

fiscalKey (string) The fiscal's withholding tax type key.

The following elements are optional:

description (string) The fiscal's withholding tax type description.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.