Taxes | Recapitulative Report

The Recapitulative Report Setups is used to manage reports such as ANEXOO or ANEXOP.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET RecapitulativeReportSetups
  • GET RecapitulativeReportSetups (paged)
  • GET RecapitulativeReportSetup by identifier
  • GET RecapitulativeReportSetup by key
  • GET Print RecapitulativeReportSetup by identifier
  • GET Print RecapitulativeReportSetup by key
  • GET Original Print RecapitulativeReportSetupOriginal by identifier
  • GET Original Print RecapitulativeReportSetup by key
• POST:
  • POST RecapitulativeReportSetups
  • POST Recapitulative Report
• PUT:
  • PUT Set IsActive RecapitulativeReportSetup
  • PUT Set RecapitulativeReportSetupKey RecapitulativeReportSetup
  • PUT Set Description RecapitulativeReportSetup
  • PUT Set TaxClass RecapitulativeReportSetup
  • PUT Set MinimumAmount RecapitulativeReportSetup
  • PUT Set FiscalSpace RecapitulativeReportSetup
  • PUT Set TaxTypeCode RecapitulativeReportSetupLine
  • PUT Set OperationType RecapitulativeReportSetupLine
• DELETE:
  • DELETE Recapitulative Report Line by identifier
  • DELETE RecapitulativeReportSetup by identifier
  • DELETE RecapitulativeReportSetup by key

All Resources

This service uses the following resources:

• ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource
• ApiRecapitulativeReportSetupResource
• RecapitulativeReportSetupLineResource
• RecapitulativeReportSetupResource

All Enumerations

This service uses the following enumerations:

• FiscalSpace

GET Operations

GET RecapitulativeReportSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET RecapitulativeReportSetups (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 RecapitulativeReportSetupResource.

Response status codes:

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

Resource URL:

GET RecapitulativeReportSetup 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 RecapitulativeReportSetupResource.

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 RecapitulativeReportSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

recapitulativeReportSetupKey

(string) The recapitulative setup key.

Response:

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

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 Print RecapitulativeReportSetup 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 Print RecapitulativeReportSetup by key

Prints the specified entity record.

The following elements are required:

recapitulativeReportSetupKey

(string) The recapitulative setup 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 Original Print RecapitulativeReportSetupOriginal 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 Original Print RecapitulativeReportSetup by key

Prints the specified entity record.

The following elements are required:

recapitulativeReportSetupKey

(string) The recapitulative setup 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:

POST Operations

POST RecapitulativeReportSetups

Creates a new entity record.

The following elements are required:

recapitulativeReportSetupResource

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

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

Response status codes:

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

Resource URL:

POST Recapitulative Report

Inserts a new 'Recapitulative Report Line' in the 'Recapitulative Report'.

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
value	(ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource) The ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource instance. See ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set Description RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup 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 Set FiscalSpace RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
value	(enum FiscalSpace) The request body should contain the new value for the attribute. See FiscalSpace.

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 Set IsActive RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup 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 Set MinimumAmount RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup 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 Set OperationType RecapitulativeReportSetupLine

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
lineId	(string) The detail identifier.
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 Set RecapitulativeReportSetupKey RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup 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 Set TaxClass RecapitulativeReportSetup

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup 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 Set TaxTypeCode RecapitulativeReportSetupLine

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

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
lineId	(string) The detail identifier.
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:

DELETE Operations

DELETE Recapitulative Report Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE RecapitulativeReportSetup 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 RecapitulativeReportSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

recapitulativeReportSetupKey

(string) The recapitulative setup 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:

Resources

ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource

The following elements are required:

taxTypeCode

(string) The tax type.

The following elements are optional:

operationType

(string) The operation type.

ApiRecapitulativeReportSetupResource

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
taxClass	(string) The tax class of the tax type codes to filter for this report.
minimumAmount	(decimal) The minimum amount to appear on report.
fiscalSpace	(enum FiscalSpace) The fiscal space of the recapitulative report. See FiscalSpace.

The following elements are optional:

description	(string) The description of the report.
recapitulativeReportSetupLines	(List of ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource) The recapitulative line's. See ApiRecapitulativeReportSetupRecapitulativeReportSetupLinesResource.

RecapitulativeReportSetupLineResource

The following elements are required:

taxTypeCode

(string) The tax type.

The following elements are optional:

operationType

(string) The operation type.

RecapitulativeReportSetupResource

The following elements are required:

recapitulativeReportSetupKey	(string) The recapitulative setup key.
taxClass	(string) The tax class of the tax type codes to filter for this report. (fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service.
minimumAmount	(decimal) The minimum amount to appear on report.
fiscalSpace	(enum FiscalSpace) The fiscal space of the recapitulative report. See FiscalSpace.

The following elements are optional:

description	(string) The description of the report.
recapitulativeReportSetupLines	(List of RecapitulativeReportSetupLineResource) The recapitulative line's. See RecapitulativeReportSetupLineResource.

Enumerations

FiscalSpace

1	National
2	EU
3	Other