ROSE Developers - Web API Reference

Financials | Journal Type

The Journal Type represents a journal document with specific characteristics.

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/journalTypes

GET JournalTypes (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 JournalTypeResource.

Response status codes:

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

Resource URL:

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

GET JournalType 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 JournalTypeResource.

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

GET JournalType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type key.

Response:

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

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/journalTypes/{companyKey}/{journalTypeKey}

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

GET Print JournalType by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type 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/journalTypes/{companyKey}/{journalTypeKey}/print

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

GET Original Print JournalType by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type 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/journalTypes/{companyKey}/{journalTypeKey}/printOriginal

POST Operations

POST JournalTypes

Creates a new entity record.

The following elements are required:

journalTypeResource (ApiJournalTypeResource) The request body should contain the entity record that should be created.
See ApiJournalTypeResource.

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

Response status codes:

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

Resource URL:

POST /financialCore/journalTypes

POST Journal Type

Inserts a new 'Journal Type Serie' in the 'Journal Type'.

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company key.
value (ApiJournalTypeJournalSeriesResource) The ApiJournalTypeJournalSeriesResource instance.
See ApiJournalTypeJournalSeriesResource.

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:

POST /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries

POST Resolve Saft Import Journal Type Series

This operation is exclusive use of the accounting SAFT-PT import and it recreate the series of a specific journal type based on the journal entries created during the importation. (RESERVED FOR INTERNAL USE).

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type key.
financialYear (int) The financial year.

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 a unique identifier.

Resource URL:

POST /financialCore/journalTypes/resolveSaftImportJournalTypeSeries/{companyKey}/{journalTypeKey}/{financialYear}

POST Resolve Saft Import Annual Series

This operation is exclusive use of the accounting SAFT-PT import and it create an annual series for a specific journal type based on company and financial year. (RESERVED FOR INTERNAL USE).

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The jounal type key.
financialYear (int) The financial year.

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 a unique identifier.

Resource URL:

POST /financialCore/journalTypes/resolveSaftImportAnnualSeries/{companyKey}/{journalTypeKey}/{financialYear}

PUT Operations

PUT Set CheckExistingPosting JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/checkExistingPosting

PUT Set Company JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/company

PUT Set Description JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/description

PUT Set FinancialYear JournalTypeSerie

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

The following elements are required:

journalTypeKey (string) The journal type key.
lineId (string) The detail identifier.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/financialYear

PUT Set From JournalTypeSerie

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

The following elements are required:

journalTypeKey (string) The journal type key.
lineId (string) The detail identifier.
companyKey (string) The company key.
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:

PUT /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/from

PUT Set IsActive JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/isActive

PUT Set JournalNumbering JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company key.
value (enum JournalNumbering) The request body should contain the new value for the attribute.
See JournalNumbering.

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/journalTypes/{companyKey}/{journalTypeKey}/journalNumbering

PUT Set JournalTypeKey JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/journalTypeKey

PUT Set Ledger JournalTypeSerie

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

The following elements are required:

journalTypeKey (string) The journal type key.
lineId (string) The detail identifier.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/ledger

PUT Set Period JournalTypeSerie

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

The following elements are required:

journalTypeKey (string) The journal type key.
lineId (string) The detail identifier.
companyKey (string) The company key.
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:

PUT /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/period

PUT Set ReverseJournalType JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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/journalTypes/{companyKey}/{journalTypeKey}/reverseJournalType

PUT Set To JournalTypeSerie

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

The following elements are required:

journalTypeKey (string) The journal type key.
lineId (string) The detail identifier.
companyKey (string) The company key.
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:

PUT /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/to

PUT Set TransactionType JournalType

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

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company key.
value (enum TransactionType) The request body should contain the new value for the attribute.
See TransactionType.

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/journalTypes/{companyKey}/{journalTypeKey}/transactionType

PUT Set Custom Attribute JournalType

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

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type 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/journalTypes/{companyKey}/{journalTypeKey}/{customAttributeName}

PUT Set Custom Attribute JournalTypeSerie

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

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type 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:

PUT /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}/{customAttributeName}

DELETE Operations

DELETE Journal Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

journalTypeKey (string) The journal type key.
companyKey (string) The company 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:

DELETE /financialCore/journalTypes/{companyKey}/{journalTypeKey}/journalSeries/{lineId}

DELETE JournalType 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/journalTypes/{id}

DELETE JournalType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type 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/journalTypes/{companyKey}/{journalTypeKey}

Resources


ApiJournalTypeJournalSeriesResource

The following elements are required:

financialYear (string) The financial year of the series.
ledger (string) The ledger of the series. By default it's the company's ledger.
from (int) The first number of the series.
to (int) The last number of the series.

The following elements are optional:

period (int) The financial period of the series (only for monthly series).


ApiJournalTypeResource

The following elements are required:

journalTypeKey (string) The journal type key.
company (string) The company of the journal type.
journalNumbering (enum JournalNumbering) The type of jounal numbering (monthly or yearly).
See JournalNumbering.
checkExistingPosting (bool) Validate duplicate documents.

The following elements are optional:

description (string) A description of the journal.
journalSeries (List of ApiJournalTypeJournalSeriesResource) The journal series.
See ApiJournalTypeJournalSeriesResource.
reverseJournalType (string) Enter the journal to be used when reversing a transaction.
transactionType (enum TransactionType) The transaction type define the process where the journal type will be used (1 - Opening, 2 - Normal, 3 - Rectification, 4 - Adjustment and 5 - Closing).
See TransactionType.


JournalTypeMainJournalSeriesResource

The following elements are required:

currentNumber (int) The current number (on insert it's defaulted to 0).
financialYear (string) The financial year of the series.
ledger (string) The ledger of the series. By default it's the company's ledger.
from (int) The first number of the series.
to (int) The last number of the series.

The following elements are optional:

period (int) The financial period of the series (only for monthly series).


JournalTypeMainResource

The following elements are required:

company (string) The company of the journal type.
journalTypeKey (string) The journal type key.
journalNumbering (enum JournalNumbering) The type of jounal numbering (monthly or yearly).
See JournalNumbering.
checkExistingPosting (bool) Validate duplicate documents.

The following elements are optional:

description (string) A description of the journal.
journalSeries (List of JournalTypeMainJournalSeriesResource) The journal series.
See JournalTypeMainJournalSeriesResource.
reverseJournalType (string) Enter the journal to be used when reversing a transaction.
transactionType (enum TransactionType) The transaction type define the process where the journal type will be used (1 - Opening, 2 - Normal, 3 - Rectification, 4 - Adjustment and 5 - Closing).
See TransactionType.


JournalTypeResource

The following elements are required:

journalTypeKey (string) The journal type key.
company (string) The company of the journal type.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
journalNumbering (enum JournalNumbering) The type of jounal numbering (monthly or yearly).
See JournalNumbering.
checkExistingPosting (bool) Validate duplicate documents.

The following elements are optional:

description (string) A description of the journal.
journalSeries (List of JournalTypeSerieResource) The journal series.
See JournalTypeSerieResource.
reverseJournalType (string) Enter the journal to be used when reversing a transaction.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
transactionType (enum TransactionType) The transaction type define the process where the journal type will be used (1 - Opening, 2 - Normal, 3 - Rectification, 4 - Adjustment and 5 - Closing).
See TransactionType.


JournalTypeSerieResource

The following elements are required:

financialYear (string) The financial year of the series.
ledger (string) The ledger of the series. By default it's the company's ledger.
currentNumber (int) The current number (on insert it's defaulted to 0).
from (int) The first number of the series.
to (int) The last number of the series.

The following elements are optional:

period (int) The financial period of the series (only for monthly series).
journalNumbering (enum JournalNumbering) Journal Numbering.
See JournalNumbering.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


JournalNumbering

1 Monthly
2 Yearly


TransactionType

1 Opening
2 Normal
3 Rectification
4 Adjustment
5 Closing