Accounting | Tax Settlement

The TaxSettlement end point is used to calculate the tax total amount to be settled or payable in specific period according the company reporting period configuration. The report period can be set to monthly, quarter our year.

Overview

URL	api/{tenantKey}/{orgKey}/accounting/taxSettlements
Methods Supported	POST, PUT, DELETE, GET

All Operations

This service includes the following operations:

• POST:
  • POST TaxSettlements
  • POST Tax Settlement
• PUT:
  • PUT Set IsActive TaxSettlement
  • PUT Set TaxReimbursement TaxSettlement
  • PUT Set TaxAmount TaxSettlement
  • PUT Set Currency TaxSettlement
  • PUT Set PostingDate TaxSettlement
  • PUT Set DocumentDate TaxSettlement
  • PUT Set Note TaxSettlement
  • PUT Set Remarks TaxSettlement
  • PUT Set CloseAccountingPeriod TaxSettlement
  • PUT Set CloseTaxPeriod TaxSettlement
  • PUT Set ChartOfAccount TaxSettlementAccount
  • PUT Set GLAccount TaxSettlementAccount
  • PUT Set AccountingNature TaxSettlementAccount
  • PUT Set Currency TaxSettlementAccount
  • PUT Set DebitAmount TaxSettlementAccount
  • PUT Set CreditAmount TaxSettlementAccount
• DELETE:
  • DELETE Tax Settlement Account by identifier
  • DELETE TaxSettlement by identifier
  • DELETE TaxSettlement by key
• GET:
  • GET Get Tax Settlements By Key

All Resources

This service uses the following resources:

• ApiTaxSettlementResource
• ApiTaxSettlementTaxSettlementAccountsResource
• MoneyResource
• TaxSettlementAccountResource
• TaxSettlementResource

All Enumerations

This service uses the following enumerations:

• AccountingNature
• ReportingPeriod

GET Operations

GET Get Tax Settlements By Key

This operation get a Tax Settlement.

The following elements are required:

companyKey	(string) The company code "abbreviation" as defined on the company setup.
year	(int) The financial year.
period	(int) The period number to get the summary as specified in the financial calendars entity.
ledger	(string) The ledger.
taxClass	(string) TaxClass.

Response:

When successful, the response body contains a resource of type 'TaxSettlementResource'. See TaxSettlementResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Operations

POST TaxSettlements

Creates a new entity record.

The following elements are required:

taxSettlementResource

(ApiTaxSettlementResource) The request body should contain the entity record that should be created. See ApiTaxSettlementResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiTaxSettlementResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Tax Settlement

Inserts a new 'Tax Settlement Account' in the 'Tax Settlement'.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
value	(ApiTaxSettlementTaxSettlementAccountsResource) The ApiTaxSettlementTaxSettlementAccountsResource instance. See ApiTaxSettlementTaxSettlementAccountsResource.

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 Operations

PUT Set AccountingNature TaxSettlementAccount

Updates the value of attribute 'AccountingNature' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum AccountingNature) The request body should contain the new value for the attribute. See AccountingNature.

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 ChartOfAccount TaxSettlementAccount

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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 CloseAccountingPeriod TaxSettlement

Updates the value of attribute 'CloseAccountingPeriod' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 CloseTaxPeriod TaxSettlement

Updates the value of attribute 'CloseTaxPeriod' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 CreditAmount TaxSettlementAccount

Updates the value of attribute 'CreditAmount' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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 Currency TaxSettlement

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 TaxSettlementAccount

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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 DebitAmount TaxSettlementAccount

Updates the value of attribute 'DebitAmount' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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 DocumentDate TaxSettlement

Updates the value of attribute 'DocumentDate' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
value	(DateTime) 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 GLAccount TaxSettlementAccount

Updates the value of attribute 'GLAccount' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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 TaxSettlement

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 Note TaxSettlement

Updates the value of attribute 'Note' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 PostingDate TaxSettlement

Updates the value of attribute 'PostingDate' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
value	(DateTime) 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 Remarks TaxSettlement

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 TaxAmount TaxSettlement

Updates the value of attribute 'TaxAmount' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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 TaxReimbursement TaxSettlement

Updates the value of attribute 'TaxReimbursement' in the specified entity record.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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:

DELETE Operations

DELETE Tax Settlement Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
companyKey	(string) The company key.
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:

DELETE TaxSettlement by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE TaxSettlement by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiTaxSettlementResource

The following elements are required:

company	(string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
chartOfAccount	(string) The chart of accounts of the company.
taxReimbursement	(bool) The tax reimbursement allows the user request (true) a tax refund, if it exists after processing.
journalType	(string) The ledger of the Tax Settlement.
taxAmount	(MoneyResource) The tax amount is the tax total calculated. This field is calculated internally. See MoneyResource .
currency	(string) The currency of the journal entry.
postingDate	(DateTime) The date when the document is created.
documentDate	(DateTime) The date when the document is issued.
closeAccountingPeriod	(bool) If true the accounting period is closed (internal).
closeTaxPeriod	(bool) If true the tax period is closed (internal).

The following elements are optional:

note	(string) A reference of the tax settlement.
remarks	(string) A place to store related information with the tax settlement.
taxSettlementAccounts	(List of ApiTaxSettlementTaxSettlementAccountsResource) Individual line items of a transaction. See ApiTaxSettlementTaxSettlementAccountsResource.

ApiTaxSettlementTaxSettlementAccountsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts of the company.
gLAccount	(string) The GLAccount of the tax settlement account.
currency	(string) The currency of the tax settlement.
debitAmount	(MoneyResource) The debit amount is the tax total calculated. See MoneyResource .
creditAmount	(MoneyResource) The debit amount is the tax total calculated. See MoneyResource .

The following elements are optional:

accountingNature

(enum AccountingNature) The accounting nature is the nature of the tax movement (debit or credit). See AccountingNature.

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.

TaxSettlementAccountResource

The following elements are required:

chartOfAccount	(string) The chart of accounts of the company.
gLAccount	(string) The GLAccount of the tax settlement account.
currency	(string) The currency of the tax settlement.
debitAmount	(MoneyResource) The debit amount is the tax total calculated. See MoneyResource .
creditAmount	(MoneyResource) The debit amount is the tax total calculated. See MoneyResource .

The following elements are optional:

accountingNature

(enum AccountingNature) The accounting nature is the nature of the tax movement (debit or credit). See AccountingNature.

TaxSettlementResource

The following elements are required:

company	(string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
taxSettlementNumber	(int) The sequential number internally determined that uniquely identifies the document within the financial year, period, company and journal type. Part of the document natural key. The financial year and period fields are obtained through the posting date.
year	(int) This field, together with the month, represents the processing period of tax payment.
month	(int) This field, together with the year, represents the processing period of tax payment.
ledger	(string) The ledger of the Tax Settlement.
taxClass	(string) The tax class will be processed.
chartOfAccount	(string) The chart of accounts of the company.
taxReimbursement	(bool) The tax reimbursement allows the user request (true) a tax refund, if it exists after processing.
journalType	(string) The ledger of the Tax Settlement.
journalNumber	(int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
taxAmount	(MoneyResource) The tax amount is the tax total calculated. This field is calculated internally. See MoneyResource .
currency	(string) The currency of the journal entry.
postingDate	(DateTime) The date when the document is created.
documentDate	(DateTime) The date when the document is issued.
closeAccountingPeriod	(bool) If true the accounting period is closed (internal).
closeTaxPeriod	(bool) If true the tax period is closed (internal).
reportingPeriod	(enum ReportingPeriod) The reporting period of taxes. It can be monthly, quarterly or yearly. This field is populated by the tax settings depending on the tax class. See ReportingPeriod.

The following elements are optional:

accountingDocument	(string) The accounting document that was assigned in accounting.
note	(string) A reference of the tax settlement.
remarks	(string) A place to store related information with the tax settlement.
taxSettlementAccounts	(List of TaxSettlementAccountResource) Individual line items of a transaction. See TaxSettlementAccountResource.

Enumerations

AccountingNature

1	Debit
2	Credit

ReportingPeriod

1	Monthly
2	Quarterly
3	Yearly