ROSE Developers - Web API Reference

Financials | Cash Flow Item

The Cash Flow Item represents the sources of a company's cash.

Overview


URL api/{tenantKey}/{orgKey}/financialCore/cashFlowItems
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET CashFlowItems

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/cashFlowItems

GET CashFlowItems (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 CashFlowItemResource.

Response status codes:

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

Resource URL:

GET /financialCore/cashFlowItems?page={page}&pageSize={pageSize}

GET CashFlowItem 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 CashFlowItemResource.

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:

GET /financialCore/cashFlowItems/{id}

GET CashFlowItem by key

Returns the entity record that matches the specified key.

The following elements are required:

cashFlowItemKey (string) The cashflow item's key.

Response:

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

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:

GET /financialCore/cashFlowItems/{cashFlowItemKey}

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

GET /financialCore/cashFlowItems/{id}/print?template={template}

GET Print CashFlowItem by key

Prints the specified entity record.

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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:

GET /financialCore/cashFlowItems/{cashFlowItemKey}/print

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

GET /financialCore/cashFlowItems/{id}/printOriginal?template={template}

GET Original Print CashFlowItem by key

Prints the specified entity record.

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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:

GET /financialCore/cashFlowItems/{cashFlowItemKey}/printOriginal

POST Operations

POST CashFlowItems

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /financialCore/cashFlowItems

PUT Operations

PUT Set CashFlowActivitiy CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's key.
value (enum CashFlowActivitiy) The request body should contain the new value for the attribute.
See CashFlowActivitiy.

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 /financialCore/cashFlowItems/{cashFlowItemKey}/cashFlowActivitiy

PUT Set CashFlowItemKey CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/cashFlowItemKey

PUT Set Description CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/description

PUT Set IsActive CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/isActive

PUT Set ItemTaxSchema CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/itemTaxSchema

PUT Set ItemWithholdingTaxSchema CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/itemWithholdingTaxSchema

PUT Set Nature CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/nature

PUT Set ValidFrom CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/validFrom

PUT Set ValidTo CashFlowItem

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

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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 /financialCore/cashFlowItems/{cashFlowItemKey}/validTo

PUT Set Custom Attribute CashFlowItem

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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:

PUT /financialCore/cashFlowItems/{cashFlowItemKey}/{customAttributeName}

DELETE Operations

DELETE CashFlowItem 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 /financialCore/cashFlowItems/{id}

DELETE CashFlowItem by key

Deletes the entity record that matches the specified key.

The following elements are required:

cashFlowItemKey (string) The cashflow item's 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:

DELETE /financialCore/cashFlowItems/{cashFlowItemKey}

Resources


ApiCashFlowItemResource

The following elements are required:

cashFlowItemKey (string) The cashflow item's key.

The following elements are optional:

description (string) The cashflow item's description.
validFrom (DateTime) The start date for validity period.
validTo (DateTime) The end date for validity period.
itemWithholdingTaxSchema (string) The associated item withholding tax schema.
itemTaxSchema (string) The associated item tax schema.
nature (enum AccountingNature) The nature of the cash flow.
See AccountingNature.
cashFlowActivitiy (enum CashFlowActivitiy) The activity assigned to the cash flow on a cash flow statement perspective.
See CashFlowActivitiy.


CashFlowItemResource

The following elements are required:

cashFlowItemKey (string) The cashflow item's key.

The following elements are optional:

description (string) The cashflow item's description.
validFrom (DateTime) The start date for validity period.
validTo (DateTime) The end date for validity period.
itemWithholdingTaxSchema (string) The associated item withholding tax schema.
(fk) Allowed value: the natural key of a record of type ItemWithholdingTaxSchema. These records are accessibly through the ItemWithholdingTaxSchemas service.
itemTaxSchema (string) The associated item tax schema.
(fk) Allowed value: the natural key of a record of type ItemTaxSchema. These records are accessibly through the ItemTaxSchemas service.
nature (enum AccountingNature) The nature of the cash flow.
See AccountingNature.
cashFlowActivitiy (enum CashFlowActivitiy) The activity assigned to the cash flow on a cash flow statement perspective.
See CashFlowActivitiy.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AccountingNature

1 Debit
2 Credit


CashFlowActivitiy

1 Operating
2 Investing
3 Financial