ROSE Developers - Web API Reference

Taxes | Fiscal Document Type

The Fiscal Document Type represents the type of document for the Portuguese Tax Authority (AT).

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/fiscalDocumentTypes

GET FiscalDocumentTypes (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 FiscalDocumentTypeResource.

Response status codes:

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

Resource URL:

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

GET FiscalDocumentType 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 FiscalDocumentTypeResource.

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

GET FiscalDocumentType by key

Returns the entity record that matches the specified key.

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.

Response:

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

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/fiscalDocumentTypes/{fiscalDocumentTypeKey}

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

GET Print FiscalDocumentType by key

Prints the specified entity record.

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.

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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/print

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

GET Original Print FiscalDocumentType by key

Prints the specified entity record.

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.

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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/printOriginal

POST Operations

POST FiscalDocumentTypes

Creates a new entity record.

The following elements are required:

fiscalDocumentTypeResource (ApiFiscalDocumentTypeResource) The request body should contain the entity record that should be created.
See ApiFiscalDocumentTypeResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/fiscalDocumentTypes

PUT Operations

PUT Set Description FiscalDocumentType

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

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/description

PUT Set FiscalDocumentTypeKey FiscalDocumentType

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

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/fiscalDocumentTypeKey

PUT Set FiscalUse FiscalDocumentType

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

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
value (enum FiscalUse) The request body should contain the new value for the attribute.
See FiscalUse.

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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/fiscalUse

PUT Set IsActive FiscalDocumentType

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

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/isActive

PUT Set Custom Attribute FiscalDocumentType

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

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type
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/fiscalDocumentTypes/{fiscalDocumentTypeKey}/{customAttributeName}

DELETE Operations

DELETE FiscalDocumentType 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/fiscalDocumentTypes/{id}

DELETE FiscalDocumentType by key

Deletes the entity record that matches the specified key.

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.

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/fiscalDocumentTypes/{fiscalDocumentTypeKey}

Resources


ApiFiscalDocumentTypeResource

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
fiscalUse (enum FiscalUse) Tax Purpose.
See FiscalUse.

The following elements are optional:

description (string) Description.


FiscalDocumentTypeResource

The following elements are required:

fiscalDocumentTypeKey (string) Fiscal Document Type.
fiscalUse (enum FiscalUse) Tax Purpose.
See FiscalUse.

The following elements are optional:

description (string) Description.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


FiscalUse

1 Financial
2 Stock
3 Other
4 Receipt