Financials | Financial Statement
The Financial Statements is used to map financial operations (eg balance sheet or profit and loss) that can be viewed in a financial statement report or financial statement by dimension.
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/financialStatements |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET FinancialStatements
- GET FinancialStatements (paged)
- GET FinancialStatement by identifier
- GET FinancialStatement by key
- GET Print FinancialStatement by identifier
- GET Print FinancialStatement by key
- GET Original Print FinancialStatementOriginal by identifier
- GET Original Print FinancialStatement by key
- POST:
-
PUT:
- PUT Set Custom Attribute FinancialStatement
- PUT Set Custom Attribute FinancialStatementItem
- PUT Set IsActive FinancialStatement
- PUT Set FinancialStatementKey FinancialStatement
- PUT Set Description FinancialStatement
- PUT Set ChartOfAccount FinancialStatement
- PUT Set PrintText FinancialStatementItem
- PUT Set ItemType FinancialStatementItem
- PUT Set SumFromLine FinancialStatementItem
- PUT Set SumToLine FinancialStatementItem
- PUT Set IgnoreIfZeroValue FinancialStatementItem
- PUT Set Line FinancialStatementItem
- PUT Set Tag FinancialStatementItem
- DELETE:
All Resources
This service uses the following resources:
- ApiFinancialStatementFinancialStatementItemsFinancialStatementAccountsResource
- ApiFinancialStatementFinancialStatementItemsFinancialStatementTaxonomiesResource
- ApiFinancialStatementFinancialStatementItemsResource
- ApiFinancialStatementResource
- FinancialStatementAccountResource
- FinancialStatementItemResource
- FinancialStatementResource
- FinancialStatementTaxonomyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET FinancialStatements
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See FinancialStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialStatements
GET /financialCore/financialStatements
GET FinancialStatements (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 FinancialStatementResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialStatements?page={page}&pageSize={pageSize}
GET /financialCore/financialStatements?page={page}&pageSize={pageSize}
GET FinancialStatement 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 FinancialStatementResource. |
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}/financialCore/financialStatements/{id}
GET /financialCore/financialStatements/{id}
GET FinancialStatement by key
Returns the entity record that matches the specified key.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
Response:
| When successful, the response body contains the entity record. See FinancialStatementResource. |
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}/financialCore/financialStatements/{financialStatementKey}
GET /financialCore/financialStatements/{financialStatementKey}
GET Print FinancialStatement 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}/financialCore/financialStatements/{id}/print?template={template}
GET /financialCore/financialStatements/{id}/print?template={template}
GET Print FinancialStatement by key
Prints the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/print
GET /financialCore/financialStatements/{financialStatementKey}/print
GET Original Print FinancialStatementOriginal 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}/financialCore/financialStatements/{id}/printOriginal?template={template}
GET /financialCore/financialStatements/{id}/printOriginal?template={template}
GET Original Print FinancialStatement by key
Prints the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/printOriginal
GET /financialCore/financialStatements/{financialStatementKey}/printOriginal
POST FinancialStatements
Creates a new entity record.
The following elements are required:
| financialStatementResource | (ApiFinancialStatementResource) The request body should contain the entity record that should be created. See ApiFinancialStatementResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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 ApiFinancialStatementResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialStatements
POST /financialCore/financialStatements
POST Financial Statement
Inserts a new 'Financial Statement Item' in the 'Financial Statement'.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| value | (ApiFinancialStatementFinancialStatementItemsResource) The ApiFinancialStatementFinancialStatementItemsResource instance. See ApiFinancialStatementFinancialStatementItemsResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems
POST /financialCore/financialStatements/{financialStatementKey}/financialStatementItems
PUT Set ChartOfAccount FinancialStatement
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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}/financialCore/financialStatements/{financialStatementKey}/chartOfAccount
PUT /financialCore/financialStatements/{financialStatementKey}/chartOfAccount
PUT Set Description FinancialStatement
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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}/financialCore/financialStatements/{financialStatementKey}/description
PUT /financialCore/financialStatements/{financialStatementKey}/description
PUT Set FinancialStatementKey FinancialStatement
Updates the value of attribute 'FinancialStatementKey' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementKey
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementKey
PUT Set IgnoreIfZeroValue FinancialStatementItem
Updates the value of attribute 'IgnoreIfZeroValue' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/ignoreIfZeroValue
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/ignoreIfZeroValue
PUT Set IsActive FinancialStatement
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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}/financialCore/financialStatements/{financialStatementKey}/isActive
PUT /financialCore/financialStatements/{financialStatementKey}/isActive
PUT Set ItemType FinancialStatementItem
Updates the value of attribute 'ItemType' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| value | (enum FinancialStatementItemType) The request body should contain the new value for the attribute. See FinancialStatementItemType. |
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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/itemType
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/itemType
PUT Set Line FinancialStatementItem
Updates the value of attribute 'Line' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| value | (int) 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/line
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/line
PUT Set PrintText FinancialStatementItem
Updates the value of attribute 'PrintText' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/printText
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/printText
PUT Set SumFromLine FinancialStatementItem
Updates the value of attribute 'SumFromLine' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| value | (int) 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/sumFromLine
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/sumFromLine
PUT Set SumToLine FinancialStatementItem
Updates the value of attribute 'SumToLine' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| value | (int) 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/sumToLine
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/sumToLine
PUT Set Tag FinancialStatementItem
Updates the value of attribute 'Tag' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| 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}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/tag
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/tag
PUT Set Custom Attribute FinancialStatement
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/{customAttributeName}
PUT /financialCore/financialStatements/{financialStatementKey}/{customAttributeName}
PUT Set Custom Attribute FinancialStatementItem
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/{customAttributeName}
PUT /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}/{customAttributeName}
DELETE Financial Statement Item by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| financialStatementKey | (string) The financial statement 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:
api/{tenantKey}/{orgKey}/financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}
DELETE /financialCore/financialStatements/{financialStatementKey}/financialStatementItems/{lineId}
DELETE FinancialStatement 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}/financialCore/financialStatements/{id}
DELETE /financialCore/financialStatements/{id}
DELETE FinancialStatement by key
Deletes the entity record that matches the specified key.
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
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}/financialCore/financialStatements/{financialStatementKey}
DELETE /financialCore/financialStatements/{financialStatementKey}
Resources
ApiFinancialStatementFinancialStatementItemsFinancialStatementAccountsResource
The following elements are required:
| gLAccount | (string) The GL account. |
| credit | (bool) Use the credit balance of the account. |
| debit | (bool) Use the debit balance of the account. |
| chartOfAccount | (string) The chart of accounts. |
| invertSign | (bool) Select this if the balance values are to be inversed (credit - debit insted of debit - credit). |
ApiFinancialStatementFinancialStatementItemsFinancialStatementTaxonomiesResource
The following elements are required:
| taxonomyClass | (string) The taxonomy class is used as key and will be used to filter taxonomies. |
| taxonomy | (string) The taxonomy will be used to calculated the financial statement item. |
The following elements are optional:
| credit | (bool) If true will sum all credit amount of the selected taxonomy. |
| debit | (bool) If true will sum all debit amount of the selected taxonomy. |
| invertSign | (bool) If true invert the sign of the taxonomy balance. |
ApiFinancialStatementFinancialStatementItemsResource
The following elements are required:
| itemType | (enum FinancialStatementItemType) The type of item (text only, account balance or sumatory).
See FinancialStatementItemType. |
The following elements are optional:
| printText | (string) The text to be printed. |
| financialStatementAccounts | (List of ApiFinancialStatementFinancialStatementItemsFinancialStatementAccountsResource) The list of financial statement accounts (for account balance item types only).
See ApiFinancialStatementFinancialStatementItemsFinancialStatementAccountsResource. |
| sumFromLine | (int) For sumatory item types the start line to sum. |
| sumToLine | (int) For sumatory item types the end line to to. |
| ignoreIfZeroValue | (bool) Set on if the item is not to be printed if it has no result. |
| line | (int) The line number (automatically set by the system). |
| tag | (string) The tag is the code of IES (Portugal only). |
| financialStatementTaxonomies | (List of ApiFinancialStatementFinancialStatementItemsFinancialStatementTaxonomiesResource) The financial statement taxonomies lines.
See ApiFinancialStatementFinancialStatementItemsFinancialStatementTaxonomiesResource. |
ApiFinancialStatementResource
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| chartOfAccount | (string) The chart of accounts. |
| purpose | (enum FinancialStatementPurpose) The purpose of the financial statement (balance sheet or profit and loss).
See FinancialStatementPurpose. |
The following elements are optional:
| description | (string) The description of the financial statement. |
| financialStatementItems | (List of ApiFinancialStatementFinancialStatementItemsResource) The list of financial statement items.
See ApiFinancialStatementFinancialStatementItemsResource. |
FinancialStatementAccountResource
The following elements are required:
| gLAccount | (string) The GL account. |
| credit | (bool) Use the credit balance of the account. |
| debit | (bool) Use the debit balance of the account. |
| chartOfAccount | (string) The chart of accounts. |
| invertSign | (bool) Select this if the balance values are to be inversed (credit - debit insted of debit - credit). |
FinancialStatementItemResource
The following elements are required:
| itemType | (enum FinancialStatementItemType) The type of item (text only, account balance or sumatory).
See FinancialStatementItemType. |
The following elements are optional:
| printText | (string) The text to be printed. |
| financialStatementAccounts | (List of FinancialStatementAccountResource) The list of financial statement accounts (for account balance item types only).
See FinancialStatementAccountResource. |
| sumFromLine | (int) For sumatory item types the start line to sum. |
| sumToLine | (int) For sumatory item types the end line to to. |
| ignoreIfZeroValue | (bool) Set on if the item is not to be printed if it has no result. |
| line | (int) The line number (automatically set by the system). |
| tag | (string) The tag is the code of IES (Portugal only). |
| financialStatementTaxonomies | (List of FinancialStatementTaxonomyResource) The financial statement taxonomies lines.
See FinancialStatementTaxonomyResource. |
FinancialStatementResource
The following elements are required:
| financialStatementKey | (string) The financial statement key. |
| chartOfAccount | (string) The chart of accounts.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service. |
| purpose | (enum FinancialStatementPurpose) The purpose of the financial statement (balance sheet or profit and loss).
See FinancialStatementPurpose. |
The following elements are optional:
| description | (string) The description of the financial statement. |
| financialStatementItems | (List of FinancialStatementItemResource) The list of financial statement items.
See FinancialStatementItemResource. |
FinancialStatementTaxonomyResource
The following elements are required:
| taxonomyClass | (string) The taxonomy class is used as key and will be used to filter taxonomies. |
| taxonomy | (string) The taxonomy will be used to calculated the financial statement item. |
The following elements are optional:
| credit | (bool) If true will sum all credit amount of the selected taxonomy. |
| debit | (bool) If true will sum all debit amount of the selected taxonomy. |
| invertSign | (bool) If true invert the sign of the taxonomy balance. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |