Taxes | Taxes Parameters

The Taxes Setup is used to manage default values for each company, such as the fiscal time zone and tax regional area.

Overview

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups

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

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxesSetups
- POST Taxes Setup
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiTaxesSetupResource
ApiTaxesSetupTaxReportingPeriodsResource
MoneyResource
TaxesSetupResource
TaxReportingPeriodResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AccountingSchema
ReportingPeriod

GET Operations

GET TaxesSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups

GET /taxesCore/taxesSetups

GET TaxesSetups (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 TaxesSetupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups?page={page}&pageSize={pageSize}

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

GET TaxesSetup 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 TaxesSetupResource.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{id}

GET /taxesCore/taxesSetups/{id}

GET TaxesSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

Response:

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

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}

GET /taxesCore/taxesSetups/{company}

GET Print TaxesSetup 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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{id}/print?template={template}

GET /taxesCore/taxesSetups/{id}/print?template={template}

GET Print TaxesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/print

GET /taxesCore/taxesSetups/{company}/print

GET Original Print TaxesSetupOriginal 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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{id}/printOriginal?template={template}

GET /taxesCore/taxesSetups/{id}/printOriginal?template={template}

GET Original Print TaxesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/printOriginal

GET /taxesCore/taxesSetups/{company}/printOriginal

POST Operations

POST TaxesSetups

Creates a new entity record.

The following elements are required:

taxesSetupResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups

POST /taxesCore/taxesSetups

POST Taxes Setup

Inserts a new 'Tax Reporting Period' in the 'Taxes Setup'.

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
value	(ApiTaxesSetupTaxReportingPeriodsResource) The ApiTaxesSetupTaxReportingPeriodsResource instance. See ApiTaxesSetupTaxReportingPeriodsResource.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxReportingPeriods

POST /taxesCore/taxesSetups/{company}/taxReportingPeriods

PUT Operations

PUT Set AccountingSchema TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/accountingSchema

PUT /taxesCore/taxesSetups/{company}/accountingSchema

PUT Set Company TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/company

PUT /taxesCore/taxesSetups/{company}/company

PUT Set Currency TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/currency

PUT /taxesCore/taxesSetups/{company}/currency

PUT Set EconomicActivityClassification TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/economicActivityClassification

PUT /taxesCore/taxesSetups/{company}/economicActivityClassification

PUT Set FiscalTimeZone TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/fiscalTimeZone

PUT /taxesCore/taxesSetups/{company}/fiscalTimeZone

PUT Set IsActive TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/isActive

PUT /taxesCore/taxesSetups/{company}/isActive

PUT Set IsPortugueseCompany TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/isPortugueseCompany

PUT /taxesCore/taxesSetups/{company}/isPortugueseCompany

PUT Set LegalRepresentativeId TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/legalRepresentativeId

PUT /taxesCore/taxesSetups/{company}/legalRepresentativeId

PUT Set PublicAuthority TaxReportingPeriod

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/publicAuthority

PUT /taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/publicAuthority

PUT Set ReportingPeriod TaxReportingPeriod

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
lineId	(string) The detail identifier.
value	(enum ReportingPeriod) The request body should contain the new value for the attribute. See ReportingPeriod.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/reportingPeriod

PUT /taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/reportingPeriod

PUT Set SimplifiedInvoiceLimitAmount TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/simplifiedInvoiceLimitAmount

PUT /taxesCore/taxesSetups/{company}/simplifiedInvoiceLimitAmount

PUT Set TaxClass TaxReportingPeriod

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/taxClass

PUT /taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}/taxClass

PUT Set TaxRegionalArea TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxRegionalArea

PUT /taxesCore/taxesSetups/{company}/taxRegionalArea

PUT Set TechnicalAccountantId TaxesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/technicalAccountantId

PUT /taxesCore/taxesSetups/{company}/technicalAccountantId

PUT Set Custom Attribute TaxesSetup

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

The following elements are required:

companyKey	(string) The company key.
company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{companyKey}/{company}/{customAttributeName}

PUT /taxesCore/taxesSetups/{companyKey}/{company}/{customAttributeName}

PUT Set Custom Attribute TaxReportingPeriod

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

The following elements are required:

companyKey	(string) The company key.
company	(string) The company code is the central organizational unit within the system.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{companyKey}/{company}/taxReportingPeriods/{lineId}/{customAttributeName}

PUT /taxesCore/taxesSetups/{companyKey}/{company}/taxReportingPeriods/{lineId}/{customAttributeName}

DELETE Operations

DELETE Tax Reporting Period by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}

DELETE /taxesCore/taxesSetups/{company}/taxReportingPeriods/{lineId}

DELETE TaxesSetup 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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{id}

DELETE /taxesCore/taxesSetups/{id}

DELETE TaxesSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxesSetups/{company}

DELETE /taxesCore/taxesSetups/{company}

Resources

ApiTaxesSetupResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
isPortugueseCompany	(bool) Internal managed flag to indicate if the company is a portuguese company.
simplifiedInvoiceLimitAmount	(MoneyResource) Simplified Invoice Limit Amount. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

economicActivityClassification	(string) The CEA's company. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
fiscalTimeZone	(string) The timezone of the company.
taxRegionalArea	(string) The Tax Regional Area indicates the region where the company take place.(ex: azores).
technicalAccountantId	(string) The Tax id of Technical account.
taxReportingPeriods	(List of ApiTaxesSetupTaxReportingPeriodsResource) The reporting periods for the tax classes. See ApiTaxesSetupTaxReportingPeriodsResource.
legalRepresentativeId	(string) The Tax id of the Legal Representative.

ApiTaxesSetupTaxReportingPeriodsResource

The following elements are required:

taxClass	(string) Tax Class that has to be reported(ex:IVA).
reportingPeriod	(enum ReportingPeriod) The period that the tax has to be reported(ex: monthly). See ReportingPeriod.
publicAuthority	(string) The public authority that the tax has to be reported(ex: AT).

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.

TaxesSetupResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
isPortugueseCompany	(bool) Internal managed flag to indicate if the company is a portuguese company.
simplifiedInvoiceLimitAmount	(MoneyResource) Simplified Invoice Limit Amount. See MoneyResource .
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.

The following elements are optional:

economicActivityClassification	(string) The CEA's company. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity. (fk) Allowed value: the natural key of a record of type EconomicActivityClassification. These records are accessibly through the EconomicActivityClassifications service.
fiscalTimeZone	(string) The timezone of the company. (fk) Allowed value: the natural key of a record of type FiscalTimeZone. These records are accessibly through the FiscalTimeZones service.
taxRegionalArea	(string) The Tax Regional Area indicates the region where the company take place.(ex: azores). (fk) Allowed value: the natural key of a record of type TaxRegionalArea. These records are accessibly through the TaxRegionalAreas service.
technicalAccountantId	(string) The Tax id of Technical account.
taxReportingPeriods	(List of TaxReportingPeriodResource) The reporting periods for the tax classes. See TaxReportingPeriodResource.
legalRepresentativeId	(string) The Tax id of the Legal Representative.

TaxReportingPeriodResource

The following elements are required:

taxClass	(string) Tax Class that has to be reported(ex:IVA).
reportingPeriod	(enum ReportingPeriod) The period that the tax has to be reported(ex: monthly). See ReportingPeriod.
publicAuthority	(string) The public authority that the tax has to be reported(ex: AT).

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Acrrual Accounting Schema.
2	Cash

ReportingPeriod

1	Monthly
2	Quarterly
3	Yearly