ROSE Developers - Web API Reference

Accounting | Journal Entry

The Journal Entries end point is used to record all business transactions and events in the accounting system. A transaction is valid if there are at least one pair of lines, a debit and a credit and the total of the debit column is equals the total of the credit column.

Overview


URL api/{tenantKey}/{orgKey}/accounting/journalEntries
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 JournalEntries

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /accounting/journalEntries

GET JournalEntries (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 JournalEntryResource.

Response status codes:

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

Resource URL:

GET /accounting/journalEntries?page={page}&pageSize={pageSize}

GET JournalEntry 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 JournalEntryResource.

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

GET JournalEntry by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.

Response:

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

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}

GET Print JournalEntry 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 /accounting/journalEntries/{id}/print?template={template}

GET Print JournalEntry by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/print

GET Original Print JournalEntryOriginal 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 /accounting/journalEntries/{id}/printOriginal?template={template}

GET Original Print JournalEntry by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/printOriginal

POST Operations

POST JournalEntries

Creates a new entity record.

The following elements are required:

journalEntryResource (ApiJournalEntryResource) The request body should contain the entity record that should be created.
See ApiJournalEntryResource.

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

Response status codes:

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

Resource URL:

POST /accounting/journalEntries

POST Journal Entry

Inserts a new 'Journal Entry Line' in the 'Journal Entry'.

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company key.
value (ApiJournalEntryJournalLinesResource) The ApiJournalEntryJournalLinesResource instance.
See ApiJournalEntryJournalLinesResource.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines

POST Journal Entry

Inserts a new 'Journal Entry W Tax' in the 'Journal Entry'.

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company key.
value (ApiJournalEntryJournalEntryWTaxesResource) The ApiJournalEntryJournalEntryWTaxesResource instance.
See ApiJournalEntryJournalEntryWTaxesResource.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalEntryWTaxes

POST Validate Financial Date

This operation validate if the fiscal date is valid in the given period. For exemple if the date is 01-01-20XX but the period is 2 then you will get an exception saying that the fiscal period must be 0 or 1.

The following elements are required:

company (string) The company code "abbreviation" as defined on the company setup.
journalType (string) JournalType.
financialPeriod (int) FinancialPeriod.
financialDate (DateTime?) The date to validate.

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 an item of type 'boolean'.

Resource URL:

POST /accounting/journalEntries/validateFiscalDate/{company}/{journalType}/{financialPeriod}

POST Reverse Journal Entry By Id

This operation does the same as the reverse journal entry, but with different parameters.

The following elements are required:

journalEntryId (Guid) The journal uniqueidentifier.
reversalInformation (ReversalResource) The resource with the information to create the reversal journal.

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 /accounting/journalEntries/reverseJournalEntryById/{journalEntryId}

POST Reverse Journal Entry

This operation will create an reversal journal entry. This is,a reversing journal entry is simply a posting that reverses a previous posting.

The following elements are required:

company (string) The company code "abbreviation" as defined on the company setup.
financialYear (int) The financial year.
ledger (string) The ledger.
journal (string) The journal type.
journalNumber (int) The journal number to revert.
reversalInformation (ReversalResource) The resource with the information to create the reversal journal.

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 /accounting/journalEntries/reverseJournalEntry/{company}/{financialYear}/{ledger}/{journal}/{journalNumber}

POST Bulk Create Journal Entries

Custom operation 'BulkCreateJournalEntries'.

The following elements are required:

bulkJournalEntry (List) BulkJournalEntry.

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.

Resource URL:

POST /accounting/journalEntries/bulkCreateJournalEntries

POST Import External Journal Entry

Custom operation 'ImportExternalJournalEntry'.

The following elements are required:

externalJournalEntry (ApiJournalEntryResource) ExternalJournalEntry.

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.

Resource URL:

POST /accounting/journalEntries/importExternalJournalEntry

PUT Operations

PUT Set AccountingNature JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/accountingNature

PUT Set AllowsWithholdingTax JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/allowsWithholdingTax

PUT Set AssetTransactionAccountType JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum AssetTransactionAccountType) The request body should contain the new value for the attribute.
See AssetTransactionAccountType.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/assetTransactionAccountType

PUT Set AssetTransactionType JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum AssetTransactionType) The request body should contain the new value for the attribute.
See AssetTransactionType.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/assetTransactionType

PUT Set AutonomousTaxation JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/autonomousTaxation

PUT Set AutoReverseDate JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/autoReverseDate

PUT Set CashFlowItem JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/cashFlowItem

PUT Set ChartOfAccount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/chartOfAccount

PUT Set Country JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/country

PUT Set CreditAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/creditAmount

PUT Set Currency JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/currency

PUT Set Currency JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/currency

PUT Set CustomsDeclaration JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/customsDeclaration

PUT Set DebitAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/debitAmount

PUT Set DeductibleAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/deductibleAmount

PUT Set DeductiblePercentage JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/deductiblePercentage

PUT Set Description JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/description

PUT Set Description JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/description

PUT Set DimensionAllocationJson JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/dimensionAllocationJson

PUT Set DocumentDate JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/documentDate

PUT Set DueDate JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/dueDate

PUT Set ExchangeRate JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/exchangeRate

PUT Set ExchangeRateDate JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/exchangeRateDate

PUT Set ExemptionReasonCode JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/exemptionReasonCode

PUT Set ExternalId JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/externalId

PUT Set FinancialAccount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/financialAccount

PUT Set FinancialAsset JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/financialAsset

PUT Set GLAccount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/gLAccount

PUT Set GLAccountNatureId JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/gLAccountNatureId

PUT Set IBAN JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/iBAN

PUT Set IsActive JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/isActive

PUT Set IsAutomatic JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/isAutomatic

PUT Set IsExternal JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/isExternal

PUT Set IsImportPreview JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/isImportPreview

PUT Set IsSaftImport JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/isSaftImport

PUT Set MainParty JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/mainParty

PUT Set MasterLineId JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/masterLineId

PUT Set MemoReason JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/memoReason

PUT Set NonDeductibleAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/nonDeductibleAmount

PUT Set Note JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/note

PUT Set OneTimeParty JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/oneTimeParty

PUT Set OverrideDocumentParty JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/overrideDocumentParty

PUT Set Party JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/party

PUT Set PartyTaxId JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/partyTaxId

PUT Set PaymentInstruction JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/paymentInstruction

PUT Set PaymentMethod JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/paymentMethod

PUT Set PaymentReference JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/paymentReference

PUT Set PrintedReportName JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/printedReportName

PUT Set Remarks JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/remarks

PUT Set ReversalFinancialYear JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/reversalFinancialYear

PUT Set ReversalIndicator JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
companyKey (string) The company key.
value (enum ReversalIndicator) The request body should contain the new value for the attribute.
See ReversalIndicator.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/reversalIndicator

PUT Set ReversalPeriod JournalEntry

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/reversalPeriod

PUT Set SourceJournalLineId JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/sourceJournalLineId

PUT Set Swift JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/swift

PUT Set TaxableAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/taxableAmount

PUT Set TaxOfficeParty JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/taxOfficeParty

PUT Set TaxPercentage JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/taxPercentage

PUT Set TaxTypeCode JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/taxTypeCode

PUT Set WithholdingNature JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum WithholdingNature) The request body should contain the new value for the attribute.
See WithholdingNature.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/withholdingNature

PUT Set WithholdingTaxableAmount JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/withholdingTaxableAmount

PUT Set WithholdingTaxCode JournalEntryLine

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

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/withholdingTaxCode

PUT Set Custom Attribute JournalEntry

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

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/{customAttributeName}

PUT Set Custom Attribute JournalEntryLine

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

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Journal Entry Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalLines/{lineId}

DELETE Journal Entry W Tax by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}/journalEntryWTaxes/{lineId}

DELETE JournalEntry 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 /accounting/journalEntries/{id}

DELETE JournalEntry by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.

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 /accounting/journalEntries/{companyKey}/{financialYear}/{journalType}/{seriesNumber}/{ledger}

Resources


ApiJournalEntryJournalEntryWTaxesResource



ApiJournalEntryJournalLinesResource

The following elements are required:

gLAccount (string) The GL account that is going to be posted.
debitAmount (MoneyResource) The debit amount of the posting.
See MoneyResource .
creditAmount (MoneyResource) The credit amount of the posting.
See MoneyResource .
isAutomatic (bool) Internal flag that is positive if the journal entry line was creatged automatically assigning a tax type code whose tax percentage is not 0%.
currency (string) The currency of the journal entry line.
chartOfAccount (string) The chart of accounts of the company.
taxableAmount (MoneyResource) The taxable amount for tax calculation purposes.
See MoneyResource .
taxPercentage (decimal) The tax percentage that is filled in the tax code for the document date of the document.
deductiblePercentage (decimal) For input tax denotes the deductible percentage of the tax amount. For output tax 100% is always used.
deductibleAmount (MoneyResource) The amount of the deductible tax amount.
See MoneyResource .
nonDeductibleAmount (MoneyResource) The amount of the non-deductible tax amount.
See MoneyResource .
oneTimeParty (bool) Internal flag that denotes if the party is one time only.
overrideDocumentParty (bool) The override document party allows the user to change the party, by default is the main party.
withholdingTaxableAmount (MoneyResource) The journal entry line withholding tax taxable amount.
See MoneyResource .

The following elements are optional:

taxTypeCode (string) The tax type code of the transaction. It can only be filled if the GL Account allows it.
party (string) The party of the transaction. It can only be filled if the GL Account sub account type is supplier or customer.
financialAccount (string) The financial account of the transaction. The system assigns automatically if we only have one account for the selected GL Account. It can be filled if the GL Account sub account type is financial account or petty cash account.
sourceJournalLineId (Guid) If the line item is automatic, then the idenfifier of the source line item is filled.
description (string) The description ot the of the journal line. By default the journal entry description is used.
cashFlowItem (string) The cash flow item of the posting. Only available and required if the sub account type of the GL account is of type petty cash or bank account. It uses the default values from the financial setup.
dueDate (DateTime) The due date of the postings. Only available if the sub account type is supplier or customer because the system will generate a open item.
accountingNature (enum AccountingNature) [Internal].
See AccountingNature.
masterLineId (Guid) The ID of the source document line (Internal).
taxOfficeParty (string) The tax office party of the tax type code or withholding tax code.
partyTaxId (string) The party tax id. By default the party tax id default value is used. The user can only change it if it's a one time party.
country (string) The country of the party. It's a readonly field.
withholdingTaxCode (string) The withholding tax code. Only available if the sub account type of the GL account is of type supplier or customer.
exemptionReasonCode (string) The exemption reason code. Only available if a tax type code is filled and the tax percentage is 0%.
paymentMethod (string) The payment method of the posting, either for open items or cash flow transactions. Only available if the sub account type is different from none.
gLAccountNatureId (Guid) The GL Account Nature Id is the nature identifier of the movement (debit or credit). It is an internal field and filled with the nature associated on gl account.
paymentReference (string) The payment reference is the document number associated to the payment issued.
customsDeclaration (string) The Custom Declaration is the document number issued by the customs services. This field is filled when there are imported merchandise.
memoReason (string) Memo Reason.
assetTransactionType (enum AssetTransactionType) The transaction type (cost or revenue) associated with the line. This field is read-only.
See AssetTransactionType.
assetTransactionAccountType (enum AssetTransactionAccountType) The transaction account type associated with the line. This field is read-only.
See AssetTransactionAccountType.
financialAsset (string) The asset to which the cost or profit will be assigned.
swift (string) The bank swift naumber.
iBAN (string) The bank IBAN.
paymentInstruction (string) The payment instruction note.
withholdingNature (enum WithholdingNature) The journal entry line nature for the withhold tax (Payable or Receivable).
See WithholdingNature.
allowsWithholdingTax (bool) Allows Withholding Tax.
autonomousTaxation (string) Autonomous Taxation.
dimensionAllocationJson (string) The json representation of the dimension allocation.


ApiJournalEntryResource

The following elements are required:

company (string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
journalType (string) The journal type of the journal entry.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
financialPeriod (int) The financial period of the journal entry. It's determined by the posting date, user can only assign special periods when the posting date is on the upper/lower margin of the calendar.
currency (string) The currency of the journal entry.
documentDate (DateTime) The date when the document is issued.
postingDate (DateTime) The date when the document is created.
autoReverse (bool) PRIMAVERA Internal use.
exchangeRate (decimal) The exchange rate between transaction currency and base currency. The base currency is set at the organization level.
mainParty (string) The main party is the party associated with the journal entry. This party will be replicated in all lines of the document, unless the user specifies another party.
isSaftImport (bool) Is Saft Import.
isExternal (bool) The JournalEntry was imported from another system.

The following elements are optional:

note (string) A reference of the journal entry, normally the external number identification (eg. the vendor document number).
journalLines (List of ApiJournalEntryJournalLinesResource) Individual line items of a transaction. There must be at least one pair of Journal Entry Lines, representing a debit and a credit.
See ApiJournalEntryJournalLinesResource.
remarks (string) A place to store related information with the journal entry.
exchangeRateDate (DateTime) The date where the exchange rate was found.
autoReverseDate (DateTime) The date where we want to post automatically a reversal document.
description (string) A description for the journal entry. By default the journal description is ued.
reversalIndicator (enum ReversalIndicator) Indication if the document is a reveresed document, a reversal document or a standard document.
See ReversalIndicator.
reversalPeriod (int) The period for reversal posting. Based on the auto reverse date.
reversalFinancialYear (string) Financial year of the reversal document.
externalInvoice (string) The external invoice field is used when the journal entry is generated by importing an EInvoice. The code contains the information of the emitter tax id and document number.
externalId (string) The external id identifies a document that has been imported from another system.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
universalUniqueId (string) Univesal unique document identifier (typically assigned by the Tax Authority, e.g. ATCUD in Portugal).
isImportPreview (bool) Indicates if the journal entry in create mode is from the picking import preview feature.


JournalEntryLineResource

The following elements are required:

gLAccount (string) The GL account that is going to be posted.
debitAmount (MoneyResource) The debit amount of the posting.
See MoneyResource .
creditAmount (MoneyResource) The credit amount of the posting.
See MoneyResource .
isAutomatic (bool) Internal flag that is positive if the journal entry line was creatged automatically assigning a tax type code whose tax percentage is not 0%.
currency (string) The currency of the journal entry line.
chartOfAccount (string) The chart of accounts of the company.
allowsOtherNature (bool) Defines whether the GL Account allows other nature. Internally determined by the GL account definition.
allowsTaxes (bool) Defines whether the GL Account allows taxes. Internally determined by the GL account definition.
taxableAmount (MoneyResource) The taxable amount for tax calculation purposes.
See MoneyResource .
taxPercentage (decimal) The tax percentage that is filled in the tax code for the document date of the document.
deductiblePercentage (decimal) For input tax denotes the deductible percentage of the tax amount. For output tax 100% is always used.
deductibleAmount (MoneyResource) The amount of the deductible tax amount.
See MoneyResource .
nonDeductibleAmount (MoneyResource) The amount of the non-deductible tax amount.
See MoneyResource .
oneTimeParty (bool) Internal flag that denotes if the party is one time only.
overrideDocumentParty (bool) The override document party allows the user to change the party, by default is the main party.
withholdingTaxableAmount (MoneyResource) The journal entry line withholding tax taxable amount.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The journal entry line total amount for the withhold tax.
See MoneyResource .
lineAmount (MoneyResource) The amount of the line used on the dimansion allocation (Internal).
See MoneyResource .

The following elements are optional:

taxTypeCode (string) The tax type code of the transaction. It can only be filled if the GL Account allows it.
party (string) The party of the transaction. It can only be filled if the GL Account sub account type is supplier or customer.
financialAccount (string) The financial account of the transaction. The system assigns automatically if we only have one account for the selected GL Account. It can be filled if the GL Account sub account type is financial account or petty cash account.
sourceJournalLineId (Guid) If the line item is automatic, then the idenfifier of the source line item is filled.
description (string) The description ot the of the journal line. By default the journal entry description is used.
cashFlowItem (string) The cash flow item of the posting. Only available and required if the sub account type of the GL account is of type petty cash or bank account. It uses the default values from the financial setup.
dueDate (DateTime) The due date of the postings. Only available if the sub account type is supplier or customer because the system will generate a open item.
subAccountTypeValue (int) The GL account sub account type. Internally determined by the GL account definition.
accountingNature (enum AccountingNature) [Internal].
See AccountingNature.
masterLineId (Guid) The ID of the source document line (Internal).
taxOfficeParty (string) The tax office party of the tax type code or withholding tax code.
partyTaxId (string) The party tax id. By default the party tax id default value is used. The user can only change it if it's a one time party.
country (string) The country of the party. It's a readonly field.
withholdingTaxCode (string) The withholding tax code. Only available if the sub account type of the GL account is of type supplier or customer.
exemptionReasonCode (string) The exemption reason code. Only available if a tax type code is filled and the tax percentage is 0%.
paymentMethod (string) The payment method of the posting, either for open items or cash flow transactions. Only available if the sub account type is different from none.
gLAccountNatureId (Guid) The GL Account Nature Id is the nature identifier of the movement (debit or credit). It is an internal field and filled with the nature associated on gl account.
paymentReference (string) The payment reference is the document number associated to the payment issued.
customsDeclaration (string) The Custom Declaration is the document number issued by the customs services. This field is filled when there are imported merchandise.
memoReason (string) Memo Reason.
fiscalMemoReason (string) [Internal].
depreciationArea (string) The depreciation area for the company ledger.
assetTransactionType (enum AssetTransactionType) The transaction type (cost or revenue) associated with the line. This field is read-only.
See AssetTransactionType.
assetTransactionAccountType (enum AssetTransactionAccountType) The transaction account type associated with the line. This field is read-only.
See AssetTransactionAccountType.
financialAsset (string) The asset to which the cost or profit will be assigned.
swift (string) The bank swift naumber.
iBAN (string) The bank IBAN.
paymentInstruction (string) The payment instruction note.
withholdingNature (enum WithholdingNature) The journal entry line nature for the withhold tax (Payable or Receivable).
See WithholdingNature.
allowsWithholdingTax (bool) Allows Withholding Tax.
automaticLineType (enum AutomaticLineType) This enum will identify the line was generate by taxes or wtax.
See AutomaticLineType.
withholdingPercentage (decimal) Rate.
autonomousTaxation (string) Autonomous Taxation.
dimensionAllocationJson (string) The json representation of the dimension allocation.


JournalEntryMainJournalLinesResource

The following elements are required:

debitAmount (MoneyResource) The debit amount of the posting.
See MoneyResource .
currency (string) The currency of the journal entry line.
gLAccount (string) The GL account that is going to be posted.
isAutomatic (bool) Internal flag that is positive if the journal entry line was creatged automatically assigning a tax type code whose tax percentage is not 0%.
allowsOtherNature (bool) Defines whether the GL Account allows other nature. Internally determined by the GL account definition.
allowsTaxes (bool) Defines whether the GL Account allows taxes. Internally determined by the GL account definition.
creditAmount (MoneyResource) The credit amount of the posting.
See MoneyResource .
overrideDocumentParty (bool) The override document party allows the user to change the party, by default is the main party.
lineAmount (MoneyResource) The amount of the line used on the dimansion allocation (Internal).
See MoneyResource .

The following elements are optional:

sourceJournalLineId (Guid) If the line item is automatic, then the idenfifier of the source line item is filled.
taxTypeCode (string) The tax type code of the transaction. It can only be filled if the GL Account allows it.
subAccountTypeValue (int) The GL account sub account type. Internally determined by the GL account definition.
accountingNature (enum AccountingNature) [Internal].
See AccountingNature.
cashFlowItem (string) The cash flow item of the posting. Only available and required if the sub account type of the GL account is of type petty cash or bank account. It uses the default values from the financial setup.
automaticLineType (enum AutomaticLineType) This enum will identify the line was generate by taxes or wtax.
See AutomaticLineType.
allowsWithholdingTax (bool) Allows Withholding Tax.
description (string) The description ot the of the journal line. By default the journal entry description is used.
country (string) The country of the party. It's a readonly field.
financialAccount (string) The financial account of the transaction. The system assigns automatically if we only have one account for the selected GL Account. It can be filled if the GL Account sub account type is financial account or petty cash account.
fiscalMemoReason (string) [Internal].
memoReason (string) Memo Reason.
party (string) The party of the transaction. It can only be filled if the GL Account sub account type is supplier or customer.
partyTaxId (string) The party tax id. By default the party tax id default value is used. The user can only change it if it's a one time party.
paymentMethod (string) The payment method of the posting, either for open items or cash flow transactions. Only available if the sub account type is different from none.
paymentReference (string) The payment reference is the document number associated to the payment issued.
dimensionAllocationJson (string) The json representation of the dimension allocation.


JournalEntryMainResource

The following elements are required:

company (string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
currency (string) The currency of the journal entry.
documentDate (DateTime) The date when the document is issued.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
financialPeriod (int) The financial period of the journal entry. It's determined by the posting date, user can only assign special periods when the posting date is on the upper/lower margin of the calendar.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
journalType (string) The journal type of the journal entry.
postingDate (DateTime) The date when the document is created.
totalCredit (MoneyResource) The total credit amount in transaction currency.
See MoneyResource .
totalDebit (MoneyResource) The total debit amount in transaction currency.
See MoneyResource .
chartOfAccount (string) The chart of accounts of the company.
mainParty (string) The main party is the party associated with the journal entry. This party will be replicated in all lines of the document, unless the user specifies another party.
ledger (string) The ledger of the journal entry.
isSaftImport (bool) Is Saft Import.
isExternal (bool) The JournalEntry was imported from another system.

The following elements are optional:

journalLines (List of JournalEntryMainJournalLinesResource) Individual line items of a transaction. There must be at least one pair of Journal Entry Lines, representing a debit and a credit.
See JournalEntryMainJournalLinesResource.
financialPeriodName (string) The name of the financial period for display purposes only.
reversalIndicator (enum ReversalIndicator) Indication if the document is a reveresed document, a reversal document or a standard document.
See ReversalIndicator.
note (string) A reference of the journal entry, normally the external number identification (eg. the vendor document number).
archiveDocumentId (string) The document's Cegid Docs unique identifier.
universalUniqueId (string) Univesal unique document identifier (typically assigned by the Tax Authority, e.g. ATCUD in Portugal).
externalInvoice (string) The external invoice field is used when the journal entry is generated by importing an EInvoice. The code contains the information of the emitter tax id and document number.


JournalEntryResource

The following elements are required:

company (string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
financialYear (string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service.
journalType (string) The journal type of the journal entry.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
seriesNumber (int) The journal number assigned to the journal entry. An journal number is a number used to identify a journal entry. It is set up in Journal Type maintenance.
ledger (string) The ledger of the journal entry.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
financialPeriod (int) The financial period of the journal entry. It's determined by the posting date, user can only assign special periods when the posting date is on the upper/lower margin of the calendar.
currency (string) The currency of the journal entry.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
documentDate (DateTime) The date when the document is issued.
postingDate (DateTime) The date when the document is created.
chartOfAccount (string) The chart of accounts of the company.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
totalCredit (MoneyResource) The total credit amount in transaction currency.
See MoneyResource .
totalDebit (MoneyResource) The total debit amount in transaction currency.
See MoneyResource .
autoReverse (bool) PRIMAVERA Internal use.
exchangeRate (decimal) The exchange rate between transaction currency and base currency. The base currency is set at the organization level.
isReversal (bool) Internal flag that denotes that the current journal entry is a reversal.
mainParty (string) The main party is the party associated with the journal entry. This party will be replicated in all lines of the document, unless the user specifies another party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
isSaftImport (bool) Is Saft Import.
isExternal (bool) The JournalEntry was imported from another system.

The following elements are optional:

note (string) A reference of the journal entry, normally the external number identification (eg. the vendor document number).
journalLines (List of JournalEntryLineResource) Individual line items of a transaction. There must be at least one pair of Journal Entry Lines, representing a debit and a credit.
See JournalEntryLineResource.
remarks (string) A place to store related information with the journal entry.
reversedJournalEntry (string) The journal entry that reversed or was reversal of the current document.
(fk) Allowed value: the natural key of a record of type JournalEntry. These records are accessibly through the JournalEntries service.
exchangeRateDate (DateTime) The date where the exchange rate was found.
autoReverseDate (DateTime) The date where we want to post automatically a reversal document.
financialPeriodName (string) The name of the financial period for display purposes only.
description (string) A description for the journal entry. By default the journal description is ued.
reversalIndicator (enum ReversalIndicator) Indication if the document is a reveresed document, a reversal document or a standard document.
See ReversalIndicator.
reversalPeriod (int) The period for reversal posting. Based on the auto reverse date.
reversalFinancialYear (string) Financial year of the reversal document.
(fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service.
isPrinted (bool) Indicates if the journal entry has been printed. Internally determined.
externalInvoice (string) The external invoice field is used when the journal entry is generated by importing an EInvoice. The code contains the information of the emitter tax id and document number.
externalId (string) The external id identifies a document that has been imported from another system.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.
universalUniqueId (string) Univesal unique document identifier (typically assigned by the Tax Authority, e.g. ATCUD in Portugal).
archiveDocumentId (string) The document's Cegid Docs unique identifier.
isImportPreview (bool) Indicates if the journal entry in create mode is from the picking import preview feature.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



ReversalResource

The following elements are optional:

reversalDate (DateTime) The reversal date. Must be greater or equal to the original document date.
reversalPeriod (int) The resersal period.
autoReverse (bool) Internal.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AccountingNature

1 Debit
2 Credit


AssetTransactionAccountType

1 AssetAccount
2 AccumulatedDepreciationAccount
3 DepreciationCostAccount
4 ImparityCostAccount
5 RevenueImparityReversalAccount
6 AccumulatedImparityAccount
9 RevenueAssetSaleAccount
10 LossAssetSaleAccount
11 DataImportClearingAccount
99 OtherAccounting


AssetTransactionType

1 Capitalization
2 Scrap
3 Sale
4 Imparity
5 OtherCosts
6 Revenue
7 Depreciation
8 RetrospectiveDepreciation


AutomaticLineType

1 Taxes
2 WithholdingTaxes
3 Reversal


ReversalIndicator

1 Reversed
2 Reversal


WithholdingNature

1 Payable
2 Receivable