ROSE Developers - Web API Reference

Financials | Ledger

The Ledger represents business activities and money (received or paid), the ledger can be budget or actual. This service manage the common operations of this entity.

Overview


URL api/{tenantKey}/{orgKey}/financialCore/ledgers
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 Ledgers

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/ledgers

GET Ledgers (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 LedgerResource.

Response status codes:

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

Resource URL:

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

GET Ledger 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 LedgerResource.

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/ledgers/{id}

GET Ledger by key

Returns the entity record that matches the specified key.

The following elements are required:

ledgerKey (string) The ledger key.

Response:

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

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/ledgers/{ledgerKey}

GET Print Ledger 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/ledgers/{id}/print?template={template}

GET Print Ledger by key

Prints the specified entity record.

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/print

GET Original Print LedgerOriginal 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/ledgers/{id}/printOriginal?template={template}

GET Original Print Ledger by key

Prints the specified entity record.

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/printOriginal

GET Get All Ledgers

This operation gets all ledgers.

Response:

When successful, the response body contains a list of resources of type 'LedgerResource'. See LedgerResource.

Response status codes:

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

Resource URL:

GET /financialCore/ledgers/getAllLedgers

POST Operations

POST Ledgers

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /financialCore/ledgers

PUT Operations

PUT Set AllowsTaxes Ledger

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

The following elements are required:

ledgerKey (string) The ledger 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.

Resource URL:

PUT /financialCore/ledgers/{ledgerKey}/allowsTaxes

PUT Set Description Ledger

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

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/description

PUT Set IsActive Ledger

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

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/isActive

PUT Set LedgerKey Ledger

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

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/ledgerKey

PUT Set LedgerType Ledger

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

The following elements are required:

ledgerKey (string) The ledger key.
value (enum LedgerType) The request body should contain the new value for the attribute.
See LedgerType.

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/ledgers/{ledgerKey}/ledgerType

PUT Set Custom Attribute Ledger

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

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}/{customAttributeName}

DELETE Operations

DELETE Ledger 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/ledgers/{id}

DELETE Ledger by key

Deletes the entity record that matches the specified key.

The following elements are required:

ledgerKey (string) The ledger 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/ledgers/{ledgerKey}

Resources


ApiLedgerResource

The following elements are required:

ledgerKey (string) The ledger key.
ledgerType (enum LedgerType) Select the type of ledger, whether it stores actual figures or budget figures.
See LedgerType.
allowsTaxes (bool) If true all transactions using this ledger will allow tax posting.

The following elements are optional:

description (string) Enter a ledger description.


LedgerResource

The following elements are required:

ledgerKey (string) The ledger key.
ledgerType (enum LedgerType) Select the type of ledger, whether it stores actual figures or budget figures.
See LedgerType.
allowsTaxes (bool) If true all transactions using this ledger will allow tax posting.

The following elements are optional:

description (string) Enter a ledger description.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


LedgerType

1 Actual
2 Budget
3 Forecast