Taxes | Tax Posting
The Tax Postings end point is used to obtain a list of tax postings.
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 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 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 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:
PUT Set Custom Attribute TaxPosting
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taxPostingKey | (int) The tax posting key. |
| 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:
Resources
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.
TaxPostingResource
The following elements are required:
| taxPostingKey | (int) The tax posting key. |
| taxableAmount | (MoneyResource) The base amount due to tax.
See MoneyResource . |
| taxAmount | (MoneyResource) The tax's amount.
See MoneyResource . |
| taxPercentage | (decimal) The tax's percentage. |
| exchangeRate | (decimal) The exchange rate from the original document. |
| documentDate | (DateTime) The document date from the original document. |
| postingDate | (DateTime) The posting date of the original document. |
| sourceDocId | (Guid) The ID of the source doc. |
| sourceDoc | (string) Identificação (legível do documento que deu origem a esta transacção de taxa). |
| currency | (string) The currency of the original document.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| taxType | (enum TaxType) The type of tax (output or input).
See TaxType. |
| taxTypeCode | (string) The tax type code.
(fk) Allowed value: the natural key of a record of type TaxTypeCode. These records are accessibly through the TaxTypeCodes service. |
| company | (string) The company code where the transaction was posted.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| deductiblePercentage | (decimal) The percentage of dedubility. |
| deductibleAmount | (MoneyResource) The amount of tax than can be deducted.
See MoneyResource . |
| schemaEntity | (string) The schema entity of the original document.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service. |
The following elements are optional:
| isExempt | (bool) Whether the transactions is exempt or not. |
| exchangeRateDate | (DateTime) The exchange rate validity start date. |
| companyTaxId | (string) The third party tax identifier. |
| country | (string) The third party tax country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| fiscalSpace | (enum FiscalSpace) The fiscal space of the parties country.
See FiscalSpace. |
| exemptionReasonCode | (string) The exemption reason associated to this template.
(fk) Allowed value: the natural key of a record of type ExemptionReasonCode. These records are accessibly through the ExemptionReasonCodes service. |
| fiscalMemoReason | (string) The fiscal reason for the memo assigned to the memo reason.
(fk) Allowed value: the natural key of a record of type FiscalMemoReason. These records are accessibly through the FiscalMemoReasons service. |
| party | (string) The third party tax.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| customsDeclaration | (string) The Custom Declaration is the document number issued by the customs services. This field is filled when there are imported merchandise. |