Taxes | Tax Settings

Service to manage entities of type 'Setup'.

Overview

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

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

All Operations

This service includes the following operations:

GET:
PUT:

All Resources

This service uses the following resources:

TaxesSetupResource

All Enumerations

This service uses the following enumerations:

AccountingSchema
AuthorityCommunicationOption

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

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 AuthorityCommPassword TaxesSetup

Updates the value of attribute 'AuthorityCommPassword' 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}/authorityCommPassword

PUT /taxesCore/taxesSetups/{company}/authorityCommPassword

PUT Set AuthorityCommUserName TaxesSetup

Updates the value of attribute 'AuthorityCommUserName' 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}/authorityCommUserName

PUT /taxesCore/taxesSetups/{company}/authorityCommUserName

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 FinancialCommOption TaxesSetup

Updates the value of attribute 'FinancialCommOption' 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 AuthorityCommunicationOption) The request body should contain the new value for the attribute. See AuthorityCommunicationOption.

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}/financialCommOption

PUT /taxesCore/taxesSetups/{company}/financialCommOption

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 IsInvoicingThirdParties TaxesSetup

Updates the value of attribute 'IsInvoicingThirdParties' 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}/isInvoicingThirdParties

PUT /taxesCore/taxesSetups/{company}/isInvoicingThirdParties

PUT Set SAFTComments TaxesSetup

Updates the value of attribute 'SAFTComments' 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}/sAFTComments

PUT /taxesCore/taxesSetups/{company}/sAFTComments

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 TransportCommOption TaxesSetup

Updates the value of attribute 'TransportCommOption' 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 AuthorityCommunicationOption) The request body should contain the new value for the attribute. See AuthorityCommunicationOption.

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}/transportCommOption

PUT /taxesCore/taxesSetups/{company}/transportCommOption

PUT Set UseTestModeCommunication TaxesSetup

Updates the value of attribute 'UseTestModeCommunication' 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}/useTestModeCommunication

PUT /taxesCore/taxesSetups/{company}/useTestModeCommunication

Resources

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.
useTestModeCommunication	(bool) Use Test Mode Communication.
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) Is Portuguese Company.
simplifiedInvoiceLimitAmount	(decimal) Simplified Invoice Limit Amount.
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
maximumTaxTypeCodes	(int) The maximum number of applicable tax rates, resulting from the intersection between the party's taxes and those of the transacted goods or services.
sameTaxSubClassesForApplicableTaxRates	(bool) Determines if the applicable tax rates resulting from the intersection between the party's taxes and item taxes must have the same tax type code sub class.
maximumEconomicActivityKey	(int) Maximum Economic Activity.
isInvoicingThirdParties	(bool) Indicates if invoicing behalf third parties is being performed.

The following elements are optional:

authorityCommUserName	(string) The username of the login that allows the user to communicate with the financial authority.
authorityCommPassword	(string) The password of the login that allows the user to communicate with the financial authority.
financialCommOption	(enum AuthorityCommunicationOption) Indicates if the communication of financial documents is is done manually or automatically. See AuthorityCommunicationOption.
transportCommOption	(enum AuthorityCommunicationOption) Indicates if the communication of transport documents is is done manually or automatically. See AuthorityCommunicationOption.
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.
sAFTComments	(string) SAF-T's additional header comments, in case of third party invoicing the issuer should be identified (tax identification and name).

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

AuthorityCommunicationOption

1	Automatic
2	Manual