Financials | Company Financial Condition
The Company Financial Condition represents a company with financial and tax information like chart of accounts, ledger and others.
This service extends Companies.
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET CompanyFinancialConditions
- GET CompanyFinancialConditions (paged)
- GET CompanyFinancialCondition by identifier
- GET CompanyFinancialCondition by key
- GET CompanyFinancialConditions (with Company)
- GET CompanyFinancialConditions (with Company) (paged)
- GET CompanyFinancialCondition (with Company) by identifier
- GET CompanyFinancialCondition (with Company) by key
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseCompanyFinancialConditionResource
- ApiCompanyFinancialConditionResource
- BaseCompanyFinancialConditionResource
- CompanyFinancialConditionResource
All Enumerations
This service uses the following enumerations:
GET CompanyFinancialConditions
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See CompanyFinancialConditionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions/extension
GET /financialCore/companyFinancialConditions/extension
GET CompanyFinancialConditions (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 CompanyFinancialConditionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions/extension?page={page}&pageSize={pageSize}
GET /financialCore/companyFinancialConditions/extension?page={page}&pageSize={pageSize}
GET CompanyFinancialCondition 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 CompanyFinancialConditionResource. |
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/companyFinancialConditions/{id}/extension
GET /financialCore/companyFinancialConditions/{id}/extension
GET CompanyFinancialCondition by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The key for de company. |
Response:
| When successful, the response body contains the entity record. See CompanyFinancialConditionResource. |
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/companyFinancialConditions/{companyKey}/extension
GET /financialCore/companyFinancialConditions/{companyKey}/extension
GET CompanyFinancialConditions (with Company)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseCompanyFinancialConditionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions
GET /financialCore/companyFinancialConditions
GET CompanyFinancialConditions (with Company) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
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 BaseCompanyFinancialConditionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions?page={page}&pageSize={pageSize}
GET /financialCore/companyFinancialConditions?page={page}&pageSize={pageSize}
GET CompanyFinancialCondition (with Company) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseCompanyFinancialConditionResource. |
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/companyFinancialConditions/{id}
GET /financialCore/companyFinancialConditions/{id}
GET CompanyFinancialCondition (with Company) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| companyKey | (string) The key for de company. |
Response:
| When successful, the response body contains the entity record. See BaseCompanyFinancialConditionResource. |
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/companyFinancialConditions/{companyKey}
GET /financialCore/companyFinancialConditions/{companyKey}
POST CompanyFinancialConditions
Creates a new entity record.
The following elements are required:
| companyFinancialConditionResource | (ApiCompanyFinancialConditionResource) The request body should contain the entity record that should be created. See ApiCompanyFinancialConditionResource. |
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 ApiCompanyFinancialConditionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions/extension
POST /financialCore/companyFinancialConditions/extension
POST CompanyFinancialConditions (with ApiBaseCompanyFinancialCondition)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| companyFinancialConditionResource | (ApiCompanyFinancialConditionResource) The request body should contain the entity record that should be created. See ApiCompanyFinancialConditionResource. |
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 ApiBaseCompanyFinancialConditionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/companyFinancialConditions
POST /financialCore/companyFinancialConditions
PUT Set ChartOfAccount CompanyFinancialCondition
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| 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/companyFinancialConditions/{companyKey}/chartOfAccount
PUT /financialCore/companyFinancialConditions/{companyKey}/chartOfAccount
PUT Set FinancialCalendar CompanyFinancialCondition
Updates the value of attribute 'FinancialCalendar' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| 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/companyFinancialConditions/{companyKey}/financialCalendar
PUT /financialCore/companyFinancialConditions/{companyKey}/financialCalendar
PUT Set IsActive CompanyFinancialCondition
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| 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/companyFinancialConditions/{companyKey}/isActive
PUT /financialCore/companyFinancialConditions/{companyKey}/isActive
PUT Set Ledger CompanyFinancialCondition
Updates the value of attribute 'Ledger' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| 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/companyFinancialConditions/{companyKey}/ledger
PUT /financialCore/companyFinancialConditions/{companyKey}/ledger
PUT Set ReportingPeriod CompanyFinancialCondition
Updates the value of attribute 'ReportingPeriod' in the specified entity record.
The following elements are required:
| companyKey | (string) The key for de company. |
| value | (enum ReportingPeriod) The request body should contain the new value for the attribute. See ReportingPeriod. |
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/companyFinancialConditions/{companyKey}/reportingPeriod
PUT /financialCore/companyFinancialConditions/{companyKey}/reportingPeriod
DELETE CompanyFinancialCondition 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/companyFinancialConditions/{id}
DELETE /financialCore/companyFinancialConditions/{id}
DELETE CompanyFinancialCondition by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The key for de company. |
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/companyFinancialConditions/{companyKey}
DELETE /financialCore/companyFinancialConditions/{companyKey}
Resources
ApiBaseCompanyFinancialConditionResource
The following elements are required:
| chartOfAccount | (string) The chart of account the company will be used on creation of the company. |
| ledger | (string) The ledger the company will be used on creation of the company. |
| financialCalendar | (string) The financial calendar the company will be used on creation of the company. |
| reportingPeriod | (enum ReportingPeriod) The reporting period the company will be used on creation of the company.
See ReportingPeriod. |
| companyKey | (string) The key for de company. |
| name | (string) The company's name. |
| companyTaxID | (string) The company's tax identifier. |
| country | (string) The company's country. |
| baseCurrency | (string) The company's base currency. |
The following elements are optional:
| isExternal | (bool) Is External. |
| showExchangeRateReversed | (bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic. |
| searchTerm | (string) Search Term. |
| telephone | (string) The company's telephone. |
| teleFax | (string) The company's telefax. |
| mobile | (string) The company's mobile. |
| electronicMail | (string) The company's electronic mail. |
| equityCapital | (string) The equity capital is defined as the amount of capital provided by the company's owner(s). |
| registrationOffice | (string) The company's registration office. |
| registrationNumber | (string) The company's registration number. |
| buildingNumber | (string) The company's building number. |
| streetName | (string) The company's street name. |
| cityName | (string) The company's city name. |
| postalZone | (string) The company's postal code. |
| address | (string) The company's address. |
| logo | (string) The company's image. |
| forceFromOrganizationConfiguration | (bool) Force From Configuration. |
| companyRegistrationData | (string) Company Registration Data. |
ApiCompanyFinancialConditionResource
The following elements are required:
| chartOfAccount | (string) The chart of account the company will be used on creation of the company. |
| ledger | (string) The ledger the company will be used on creation of the company. |
| financialCalendar | (string) The financial calendar the company will be used on creation of the company. |
| reportingPeriod | (enum ReportingPeriod) The reporting period the company will be used on creation of the company.
See ReportingPeriod. |
| companyKey | (string) The key for de company. |
BaseCompanyFinancialConditionResource
The following elements are required:
| chartOfAccount | (string) The chart of account the company will be used on creation of the company. |
| ledger | (string) The ledger the company will be used on creation of the company. |
| financialCalendar | (string) The financial calendar the company will be used on creation of the company. |
| reportingPeriod | (enum ReportingPeriod) The reporting period the company will be used on creation of the company.
See ReportingPeriod. |
| companyKey | (string) The key for de company. |
| name | (string) The company's name. |
| companyTaxID | (string) The company's tax identifier. |
| country | (string) The company's country. |
| baseCurrency | (string) The company's base currency. |
The following elements are optional:
| isExternal | (bool) Is External. |
| showExchangeRateReversed | (bool) Indicates wheter the exchange rate for the base currency is presented with reversed logic. |
| searchTerm | (string) Search Term. |
| telephone | (string) The company's telephone. |
| teleFax | (string) The company's telefax. |
| mobile | (string) The company's mobile. |
| electronicMail | (string) The company's electronic mail. |
| equityCapital | (string) The equity capital is defined as the amount of capital provided by the company's owner(s). |
| registrationOffice | (string) The company's registration office. |
| registrationNumber | (string) The company's registration number. |
| buildingNumber | (string) The company's building number. |
| streetName | (string) The company's street name. |
| cityName | (string) The company's city name. |
| postalZone | (string) The company's postal code. |
| address | (string) The company's address. |
| logo | (string) The company's image. |
| forceFromOrganizationConfiguration | (bool) Force From Configuration. |
| companyRegistrationData | (string) Company Registration Data. |
CompanyFinancialConditionResource
The following elements are required:
| chartOfAccount | (string) The chart of account the company will be used on creation of the company.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service. |
| ledger | (string) The ledger the company will be used on creation of the company.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service. |
| financialCalendar | (string) The financial calendar the company will be used on creation of the company.
(fk) Allowed value: the natural key of a record of type FinancialCalendar. These records are accessibly through the FinancialCalendars service. |
| reportingPeriod | (enum ReportingPeriod) The reporting period the company will be used on creation of the company.
See ReportingPeriod. |
| companyKey | (string) The key for de company. |