Taxes | Tax Settings
Service to manage entities of type 'Setup'.
Overview
URL | api/{tenantKey}/{orgKey}/taxesCore/taxesSetups |
Methods Supported | GET, PUT |
All Operations
This service includes the following operations:
- GET:
-
PUT:
- PUT Set IsActive TaxesSetup
- PUT Set Company TaxesSetup
- PUT Set AuthorityCommUserName TaxesSetup
- PUT Set AuthorityCommPassword TaxesSetup
- PUT Set FinancialCommOption TaxesSetup
- PUT Set TransportCommOption TaxesSetup
- PUT Set UseTestModeCommunication TaxesSetup
- PUT Set EconomicActivityClassification TaxesSetup
- PUT Set AccountingSchema TaxesSetup
- PUT Set FiscalTimeZone TaxesSetup
- PUT Set SimplifiedInvoiceLimitAmount TaxesSetup
- PUT Set Currency TaxesSetup
- PUT Set IsInvoicingThirdParties TaxesSetup
- PUT Set SAFTComments TaxesSetup
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET TaxesSetups (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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 | (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. |
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). |