Taxes | Corporate Tax

The Corporate Tax is used to create Model 22 based on tax report setups.

Overview

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes

URL	api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST CorporateTaxes
PUT:
- PUT Set IsActive CorporateTax
- PUT Set Remarks CorporateTax
DELETE:
- DELETE CorporateTax by identifier
- DELETE CorporateTax by key

All Resources

This service uses the following resources:

ApiCorporateTaxResource
CorporateTaxResource
MoneyResource

All Enumerations

This service uses the following enumerations:

CorporateTaxType
EnterpriseType
TaxReportState

GET Operations

GET CorporateTaxes

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See CorporateTaxResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes

GET /taxAuthorityPT/corporateTaxes

GET CorporateTaxes (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 CorporateTaxResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes?page={page}&pageSize={pageSize}

GET /taxAuthorityPT/corporateTaxes?page={page}&pageSize={pageSize}

GET CorporateTax 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 CorporateTaxResource.

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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{id}

GET /taxAuthorityPT/corporateTaxes/{id}

GET CorporateTax by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.

Response:

When successful, the response body contains the entity record. See CorporateTaxResource.

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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}

GET /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}

GET Print CorporateTax 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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{id}/print?template={template}

GET /taxAuthorityPT/corporateTaxes/{id}/print?template={template}

GET Print CorporateTax by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.

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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/print

GET /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/print

GET Original Print CorporateTaxOriginal 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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{id}/printOriginal?template={template}

GET /taxAuthorityPT/corporateTaxes/{id}/printOriginal?template={template}

GET Original Print CorporateTax by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.

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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/printOriginal

GET /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/printOriginal

POST Operations

POST CorporateTaxes

Creates a new entity record.

The following elements are required:

corporateTaxResource

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

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 ApiCorporateTaxResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes

POST /taxAuthorityPT/corporateTaxes

PUT Operations

PUT Set IsActive CorporateTax

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

The following elements are required:

corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.
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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/isActive

PUT /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/isActive

PUT Set Remarks CorporateTax

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

The following elements are required:

corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.
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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/remarks

PUT /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}/remarks

DELETE Operations

DELETE CorporateTax 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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{id}

DELETE /taxAuthorityPT/corporateTaxes/{id}

DELETE CorporateTax by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.

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:

api/{tenantKey}/{orgKey}/taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}

DELETE /taxAuthorityPT/corporateTaxes/{companyKey}/{corporateTaxKey}

Resources

ApiCorporateTaxResource

The following elements are required:

corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.
company	(string) The legal declaration's company. The company code is the central organizational unit within the system.
financialYear	(string) The financial year of the corporate tax. (ex: 2020).
corporateTaxType	(enum CorporateTaxType) The corporate tax declaration type. if is the first or subtitute declaration. See CorporateTaxType.
enterpriseType	(enum EnterpriseType) Type of the enterprise (ex.: small, medium). See EnterpriseType.
deductibleLoss	(MoneyResource) Deductible Losses. See MoneyResource .
deductedLoss	(MoneyResource) Deducted Losses. See MoneyResource .

The following elements are optional:

outOfLegalTermDate	(DateTime) The date of the subtitute declaration.
remarks	(string) The corporate tax remarks.

CorporateTaxResource

The following elements are required:

corporateTaxKey	(string) The corporate taxes key. By default, it is a sequential number.
company	(string) The legal declaration's company. 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.
financialYear	(string) The financial year of the corporate tax. (ex: 2020). (fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service.
corporateTaxType	(enum CorporateTaxType) The corporate tax declaration type. if is the first or subtitute declaration. See CorporateTaxType.
enterpriseType	(enum EnterpriseType) Type of the enterprise (ex.: small, medium). See EnterpriseType.
deductibleLoss	(MoneyResource) Deductible Losses. See MoneyResource .
deductedLoss	(MoneyResource) Deducted Losses. See MoneyResource .
currency	(string) The company of the tax report.(ex: €). (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
payableTax	(MoneyResource) This value refers to the payable tax amount. See MoneyResource .
receivableTax	(MoneyResource) This value refers to the receivable tax amount. See MoneyResource .

The following elements are optional:

outOfLegalTermDate	(DateTime) The date of the subtitute declaration.
remarks	(string) The corporate tax remarks.
status	(enum TaxReportState) Status of the document. See TaxReportState.

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.

Enumerations

CorporateTaxType

1	FirstDeclarationPeriod	First declaration type.
2	SubstitutionDeclarationArt122n1and2	Substitution declaration type art.º 122 number 1 and 2.
3	SubstitutionDeclarationArt64	Substitution Declaration type art.º 64 number 4.
4	SubstitutionDeclarationArt120	Substitution declaration type art.º 120, numbers 8 and 9.
5	SubstitutionDeclarationOutOfTerm	Substitution declaration type out of legal term.
6	SubstitutionDeclarationArt122n3	Substitution declaration type art.º 122, number 3.

EnterpriseType

1	MicroEnterprise	Micro type.
2	SmallEnterprise	Small type.
3	MediumEnterprise	Medium type.
4	NoSME	No SME type.

TaxReportState

1	Pending
2	Processing
3	Succeeded
4	Failed