ROSE Developers - Web API Reference

Taxes | Fiscal Memo Reason

The Fiscal Memo Reason represents the classification of a memo document.

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/fiscalMemoReasons

GET FiscalMemoReasons (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 FiscalMemoReasonResource.

Response status codes:

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

Resource URL:

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

GET FiscalMemoReason 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 FiscalMemoReasonResource.

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

GET FiscalMemoReason by key

Returns the entity record that matches the specified key.

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason key.

Response:

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

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/fiscalMemoReasons/{fiscalMemoReasonKey}

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

GET Print FiscalMemoReason by key

Prints the specified entity record.

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/print

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

GET Original Print FiscalMemoReason by key

Prints the specified entity record.

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/printOriginal

POST Operations

POST FiscalMemoReasons

Creates a new entity record.

The following elements are required:

fiscalMemoReasonResource (ApiFiscalMemoReasonResource) The request body should contain the entity record that should be created.
See ApiFiscalMemoReasonResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/fiscalMemoReasons

PUT Operations

PUT Set Description FiscalMemoReason

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

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/description

PUT Set FiscalMemoReasonKey FiscalMemoReason

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

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/fiscalMemoReasonKey

PUT Set FiscalMemoReasonType FiscalMemoReason

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

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason key.
value (enum FiscalMemoReasonType) The request body should contain the new value for the attribute.
See FiscalMemoReasonType.

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/fiscalMemoReasons/{fiscalMemoReasonKey}/fiscalMemoReasonType

PUT Set IsActive FiscalMemoReason

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

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/isActive

PUT Set Custom Attribute FiscalMemoReason

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

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}/{customAttributeName}

DELETE Operations

DELETE FiscalMemoReason 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/fiscalMemoReasons/{id}

DELETE FiscalMemoReason by key

Deletes the entity record that matches the specified key.

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason 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/fiscalMemoReasons/{fiscalMemoReasonKey}

Resources


ApiFiscalMemoReasonResource

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason key.
fiscalMemoReasonType (enum FiscalMemoReasonType) Fiscal Memo Reason Type.
See FiscalMemoReasonType.

The following elements are optional:

description (string) The description of the fiscal memo reason.


FiscalMemoReasonResource

The following elements are required:

fiscalMemoReasonKey (string) The fiscal memo reason key.
fiscalMemoReasonType (enum FiscalMemoReasonType) Fiscal Memo Reason Type.
See FiscalMemoReasonType.

The following elements are optional:

description (string) The description of the fiscal memo reason.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


FiscalMemoReasonType

1 InputTax
2 OutputTax
3 Both