Taxes | Tax Authority Setup PT
The Tax Authority Setup is used to manage default values for each company, such as the Communication to the Tax Authority and Tax Reporting.
Overview
| URL | api/{tenantKey}/{orgKey}/taxAuthorityPT/taxAuthoritySetupPTs |
| Methods Supported | GET, PUT, POST, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET TaxAuthoritySetupPTs
- GET TaxAuthoritySetupPTs (paged)
- GET TaxAuthoritySetupPT by identifier
- GET TaxAuthoritySetupPT by key
- GET Print TaxAuthoritySetupPT by identifier
- GET Print TaxAuthoritySetupPT by key
- GET Original Print TaxAuthoritySetupPTOriginal by identifier
- GET Original Print TaxAuthoritySetupPT by key
-
PUT:
- PUT Set Custom Attribute TaxAuthoritySetupPT
- PUT Set IsActive TaxAuthoritySetupPT
- PUT Set Company TaxAuthoritySetupPT
- PUT Set FinancialCommOption TaxAuthoritySetupPT
- PUT Set TransportCommOption TaxAuthoritySetupPT
- PUT Set AuthorityCommUserName TaxAuthoritySetupPT
- PUT Set AuthorityCommPassword TaxAuthoritySetupPT
- PUT Set AuthorityServiceCode TaxAuthoritySetupPT
- PUT Set BalanceSheet TaxAuthoritySetupPT
- PUT Set ProfitAndLoss TaxAuthoritySetupPT
- PUT Set AccountingTaxonomy TaxAuthoritySetupPT
- PUT Set CustomerRecapitulative TaxAuthoritySetupPT
- PUT Set SupplierRecapitulative TaxAuthoritySetupPT
- PUT Set Model TaxAuthoritySetupDetail
- PUT Set Attachment TaxAuthoritySetupDetail
- PUT Set TaxReportSetup TaxAuthoritySetupDetail
- PUT Set DynamicValueList TaxAuthoritySetupDetail
- POST:
- DELETE:
All Resources
This service uses the following resources:
- ApiTaxAuthoritySetupPTResource
- ApiTaxAuthoritySetupPTTaxReportingLinesResource
- TaxAuthoritySetupDetailResource
- TaxAuthoritySetupPTResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET TaxAuthoritySetupPTs
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See TaxAuthoritySetupPTResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxAuthoritySetupPTs (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 TaxAuthoritySetupPTResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxAuthoritySetupPT 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 TaxAuthoritySetupPTResource. |
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 TaxAuthoritySetupPT 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 TaxAuthoritySetupPTResource. |
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 TaxAuthoritySetupPT 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 TaxAuthoritySetupPT 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:
GET Original Print TaxAuthoritySetupPTOriginal 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 TaxAuthoritySetupPT 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:
POST Tax Authority Setup PT
Inserts a new 'Tax Authority Setup Detail' in the 'Tax Authority Setup PT'.
The following elements are required:
| company | (string) The company code is the central organizational unit within the system. |
| value | (ApiTaxAuthoritySetupPTTaxReportingLinesResource) The ApiTaxAuthoritySetupPTTaxReportingLinesResource instance. See ApiTaxAuthoritySetupPTTaxReportingLinesResource. |
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:
PUT Set AccountingTaxonomy TaxAuthoritySetupPT
Updates the value of attribute 'AccountingTaxonomy' 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 AccountingTaxonomy) The request body should contain the new value for the attribute. See AccountingTaxonomy. |
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 Attachment TaxAuthoritySetupDetail
Updates the value of attribute 'Attachment' 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:
PUT Set AuthorityCommPassword TaxAuthoritySetupPT
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 TaxAuthoritySetupPT
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 AuthorityServiceCode TaxAuthoritySetupPT
Updates the value of attribute 'AuthorityServiceCode' 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 BalanceSheet TaxAuthoritySetupPT
Updates the value of attribute 'BalanceSheet' 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 TaxAuthoritySetupPT
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 CustomerRecapitulative TaxAuthoritySetupPT
Updates the value of attribute 'CustomerRecapitulative' 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 DynamicValueList TaxAuthoritySetupDetail
Updates the value of attribute 'DynamicValueList' 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:
PUT Set FinancialCommOption TaxAuthoritySetupPT
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 IsActive TaxAuthoritySetupPT
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 Model TaxAuthoritySetupDetail
Updates the value of attribute 'Model' 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:
PUT Set ProfitAndLoss TaxAuthoritySetupPT
Updates the value of attribute 'ProfitAndLoss' 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 SupplierRecapitulative TaxAuthoritySetupPT
Updates the value of attribute 'SupplierRecapitulative' 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 TaxReportSetup TaxAuthoritySetupDetail
Updates the value of attribute 'TaxReportSetup' 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:
PUT Set TransportCommOption TaxAuthoritySetupPT
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 Custom Attribute TaxAuthoritySetupPT
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:
DELETE Tax Authority Setup Detail 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:
Resources
ApiTaxAuthoritySetupPTResource
The following elements are required:
| company | (string) The company code is the central organizational unit within the system. |
The following elements are optional:
| 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. |
| 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. |
| authorityServiceCode | (string) Authority Service Code. |
| taxReportingLines | (List of ApiTaxAuthoritySetupPTTaxReportingLinesResource) The tax reporting configuration.
See ApiTaxAuthoritySetupPTTaxReportingLinesResource. |
| balanceSheet | (string) The balanace sheet model to use in IES (Informação Empresarial Simplificada). |
| profitAndLoss | (string) The profit and loss model to use in IES (Informação Empresarial Simplificada). |
| accountingTaxonomy | (enum AccountingTaxonomy) The accounting taxonomy used in IES report (Informação Empresarial Simplificada).
See AccountingTaxonomy. |
| customerRecapitulative | (string) The Customer Recapitulative Report used in IES report (Informação Empresarial Simplificada). |
| supplierRecapitulative | (string) The Supplier Recapitulative Report used in IES report (Informação Empresarial Simplificada). |
ApiTaxAuthoritySetupPTTaxReportingLinesResource
The following elements are required:
| model | (string) The Model associeted to the tax report. |
| attachment | (string) The Attachment associeted to the tax report. |
| taxReportSetup | (string) The Tax Report. |
The following elements are optional:
| dynamicValueList | (string) (internal use). |
TaxAuthoritySetupDetailResource
The following elements are required:
| model | (string) The Model associeted to the tax report. |
| attachment | (string) The Attachment associeted to the tax report. |
| taxReportSetup | (string) The Tax Report. |
The following elements are optional:
| dynamicValueList | (string) (internal use). |
TaxAuthoritySetupPTResource
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. |
The following elements are optional:
| 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. |
| 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. |
| authorityServiceCode | (string) Authority Service Code. |
| taxReportingLines | (List of TaxAuthoritySetupDetailResource) The tax reporting configuration.
See TaxAuthoritySetupDetailResource. |
| balanceSheet | (string) The balanace sheet model to use in IES (Informação Empresarial Simplificada).
(fk) Allowed value: the natural key of a record of type FinancialStatement. These records are accessibly through the FinancialStatements service. |
| profitAndLoss | (string) The profit and loss model to use in IES (Informação Empresarial Simplificada).
(fk) Allowed value: the natural key of a record of type FinancialStatement. These records are accessibly through the FinancialStatements service. |
| accountingTaxonomy | (enum AccountingTaxonomy) The accounting taxonomy used in IES report (Informação Empresarial Simplificada).
See AccountingTaxonomy. |
| customerRecapitulative | (string) The Customer Recapitulative Report used in IES report (Informação Empresarial Simplificada).
(fk) Allowed value: the natural key of a record of type RecapitulativeReportSetup. These records are accessibly through the RecapitulativeReportSetups service. |
| supplierRecapitulative | (string) The Supplier Recapitulative Report used in IES report (Informação Empresarial Simplificada).
(fk) Allowed value: the natural key of a record of type RecapitulativeReportSetup. These records are accessibly through the RecapitulativeReportSetups service. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |