Taxes | Tax Posting
Service to manage entities of type 'TaxPosting'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/taxPostings |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET TaxPostings
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See TaxPostingResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxPostings (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 TaxPostingResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxPosting 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 TaxPostingResource. |
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 TaxPosting by key
Returns the entity record that matches the specified key.
The following elements are required:
| taxPostingKey | (int) The tax's posting key. |
Response:
| When successful, the response body contains the entity record. See TaxPostingResource. |
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 TaxPosting 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 TaxPosting by key
Prints the specified entity record.
The following elements are required:
| taxPostingKey | (int) The tax's posting 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 TaxPostingOriginal 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 TaxPosting by key
Prints the specified entity record.
The following elements are required:
| taxPostingKey | (int) The tax's posting 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:
Resources
TaxPostingResource
The following elements are required:
| taxableAmount | (decimal) The taxable amount. |
| taxAmount | (decimal) The tax's amount. |
| taxPercentage | (decimal) The tax's percentage. |
| exchangeRate | (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| taxPostingKey | (int) The tax's posting key. |
| issueDate | (DateTime) Data da transação original. |
| postingDate | (DateTime) Data em que a transacção é contabilizada. |
| sourceDocId | (Guid) Source Doc. Id. |
| sourceDoc | (string) Identificação (legível do documento que deu origem a esta transacção de taxa). |
| currency | (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| country | (string) Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| taxTypeCode | (string) Tax Type Code.
(fk) Allowed value: the natural key of a record of type TaxTypeCode. These records are accessibly through the TaxTypeCodes service. |
| taxSummary | (string) Tax Summary.
(fk) Allowed value: the natural key of a record of type TaxSummary. |
| schemaEntity | (string) Schema Entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service. |
| postDocSchemaEntity | (string) Post. Doc. Schema Entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| deductiblePercentage | (decimal) Deductible. |
| deductibleAmount | (decimal) Deductible Amount. |
The following elements are optional:
| isExempt | (bool) Is exempt. |
| exchangeRateDate | (DateTime) The exchange rate creation date. |
| companyTaxId | (string) The company's tax identifier. |
| postDocId | (Guid) Posting Doc. Id. |
| postDoc | (string) Posting Doc. |
| fiscalSpace | (enum FiscalSpace) Tax Regional Area.
See FiscalSpace. |
| exemptionReasonCode | (string) Exemption Reason Code.
(fk) Allowed value: the natural key of a record of type ExemptionReasonCode. These records are accessibly through the ExemptionReasonCodes service. |