Portuguese Payroll | Income Statement
Service to manage entities of type 'IncomeStatement'.
Overview
| URL | api/{tenantKey}/{orgKey}/payrollPT/incomeStatements |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
- ApiIncomeStatementDeductionsResource
- ApiIncomeStatementExemptsResource
- ApiIncomeStatementFreesResource
- ApiIncomeStatementResource
- ApiIncomeStatementSubjectsResource
- ApiIncomeStatementTaxesResource
- IncomeStatementDeductionResource
- IncomeStatementExemptResource
- IncomeStatementFreeResource
- IncomeStatementResource
- IncomeStatementSubjectResource
- IncomeStatementTaxResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET IncomeStatements
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See IncomeStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollPT/incomeStatements
GET /payrollPT/incomeStatements
GET IncomeStatements (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 IncomeStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollPT/incomeStatements?page={page}&pageSize={pageSize}
GET /payrollPT/incomeStatements?page={page}&pageSize={pageSize}
GET IncomeStatement 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 IncomeStatementResource. |
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}/payrollPT/incomeStatements/{id}
GET /payrollPT/incomeStatements/{id}
GET IncomeStatement by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| incomeStatementKey | (string) Income Statement. |
Response:
| When successful, the response body contains the entity record. See IncomeStatementResource. |
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}/payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}
GET /payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}
GET Print IncomeStatement 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}/payrollPT/incomeStatements/{id}/print?template={template}
GET /payrollPT/incomeStatements/{id}/print?template={template}
GET Print IncomeStatement by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| incomeStatementKey | (string) Income Statement. |
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}/payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}/print
GET /payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}/print
GET Original Print IncomeStatementOriginal 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}/payrollPT/incomeStatements/{id}/printOriginal?template={template}
GET /payrollPT/incomeStatements/{id}/printOriginal?template={template}
GET Original Print IncomeStatement by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| incomeStatementKey | (string) Income Statement. |
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}/payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}/printOriginal
GET /payrollPT/incomeStatements/{companyKey}/{incomeStatementKey}/printOriginal
POST IncomeStatements
Creates a new entity record.
The following elements are required:
| incomeStatementResource | (ApiIncomeStatementResource) The request body should contain the entity record that should be created. See ApiIncomeStatementResource. |
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 ApiIncomeStatementResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollPT/incomeStatements
POST /payrollPT/incomeStatements
Resources
ApiIncomeStatementDeductionsResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
ApiIncomeStatementExemptsResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
ApiIncomeStatementFreesResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
ApiIncomeStatementResource
The following elements are required:
| incomeStatementKey | (string) Income Statement. |
| employee | (string) Employee. |
| year | (int) Year. |
| company | (string) Company. |
| fiscalState | (enum FiscalState) Fiscal State.
See FiscalState. |
| earningType | (enum EarningType) Earning Type.
See EarningType. |
| subjectsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| subjectsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| freesTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| freesTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| exemptsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| exemptsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| taxesTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| taxesTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| deductionsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| deductionsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| dependents | (int) Dependents. |
| isPrinted | (bool) Is Printed. |
| subjects | (List of ApiIncomeStatementSubjectsResource) Subjects.
See ApiIncomeStatementSubjectsResource. |
| frees | (List of ApiIncomeStatementFreesResource) Frees.
See ApiIncomeStatementFreesResource. |
| exempts | (List of ApiIncomeStatementExemptsResource) Exempts.
See ApiIncomeStatementExemptsResource. |
| deductions | (List of ApiIncomeStatementDeductionsResource) Deductions.
See ApiIncomeStatementDeductionsResource. |
| taxes | (List of ApiIncomeStatementTaxesResource) Taxes.
See ApiIncomeStatementTaxesResource. |
| printedReportName | (string) Printed Report Name. |
| isReprinted | (bool) Is Reprinted. |
| isSigned | (bool) Is Signed. |
ApiIncomeStatementSubjectsResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
ApiIncomeStatementTaxesResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
IncomeStatementDeductionResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
IncomeStatementExemptResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
IncomeStatementFreeResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
IncomeStatementResource
The following elements are required:
| incomeStatementKey | (string) Income Statement. |
| employee | (string) Employee.
(fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service. |
| year | (int) Year. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. |
| fiscalState | (enum FiscalState) Fiscal State.
See FiscalState. |
| earningType | (enum EarningType) Earning Type.
See EarningType. |
| subjectsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| subjectsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| freesTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| freesTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| exemptsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| exemptsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| taxesTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| taxesTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| deductionsTotalValueYear | (MoneyResource) Total Year.
See MoneyResource . |
| deductionsTotalValuePrevYear | (MoneyResource) Total Previous Years.
See MoneyResource . |
| currency | (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. |
The following elements are optional:
| dependents | (int) Dependents. |
| isPrinted | (bool) Is Printed. |
| subjects | (List of IncomeStatementSubjectResource) Subjects.
See IncomeStatementSubjectResource. |
| frees | (List of IncomeStatementFreeResource) Frees.
See IncomeStatementFreeResource. |
| exempts | (List of IncomeStatementExemptResource) Exempts.
See IncomeStatementExemptResource. |
| deductions | (List of IncomeStatementDeductionResource) Deductions.
See IncomeStatementDeductionResource. |
| taxes | (List of IncomeStatementTaxResource) Taxes.
See IncomeStatementTaxResource. |
| printedReportName | (string) Printed Report Name. |
| isReprinted | (bool) Is Reprinted. |
| isSigned | (bool) Is Signed. |
IncomeStatementSubjectResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
IncomeStatementTaxResource
The following elements are required:
| year | (int) Year. |
| value | (MoneyResource) Value.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| deduction | (string) Deduction. |
| type | (string) Type. |
| nature | (string) Nature. |
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.