ROSE Developers - Web API Reference

Financials | Account Posting

The Account Posting represents the accounting data of a document.

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/accountPostings

GET AccountPostings (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 AccountPostingResource.

Response status codes:

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

Resource URL:

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

GET AccountPosting 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 AccountPostingResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /financialCore/accountPostings/{id}

GET AccountPosting by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

Response:

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

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /financialCore/accountPostings/{companyKey}/{postingKey}

GET Print AccountPosting by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

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

GET Print AccountPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /financialCore/accountPostings/{companyKey}/{postingKey}/print

GET Original Print AccountPostingOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

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

GET Original Print AccountPosting by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /financialCore/accountPostings/{companyKey}/{postingKey}/printOriginal

GET Validate Existing Postings

This operation verifies the existence of any financial posting for a given document.

The following elements are required:

companyKey (string) The company key.
journalTypeKey (string) The journal type key.
partyKey (string) The party key.
reference (string) The Note Field : Representing the External Reference.
documentDate (DateTime?) The document date.

Response:

When successful, the response body contains an item of type 'boolean'.

Response status codes:

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

Resource URL:

GET /financialCore/accountPostings/validateExistingPostings/{companyKey}/{journalTypeKey}/{partyKey}/{reference}

POST Operations

POST AccountPostings

Creates a new entity record.

The following elements are required:

accountPostingResource (ApiAccountPostingResource) The request body should contain the entity record that should be created.
See ApiAccountPostingResource.

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

Response status codes:

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

Resource URL:

POST /financialCore/accountPostings

POST Get Total Account Postings

This operation gets the account posting total amount.

The following elements are required:

accountKey (string) The GL Account key.
ledger (string) The Ledger key.
company (string) The Company key.
financialYear (int) The Finacial Year key.

Response:

When successful, the response body contains an item of type 'number'.

Resource URL:

POST /financialCore/accountPostings/getTotalAccountPostings

POST Get Last Account Posting Date

This operation gets the last account date.

The following elements are required:

accountKey (string) The GL Account Key.
ledger (string) The Ledger key.
company (string) The Company key.
financialYear (int) The Finacial Year key.

Response:

When successful, the response body contains an item of type 'date'.

Resource URL:

POST /financialCore/accountPostings/getLastAccountPostingDate

PUT Operations

PUT Set AccountingSchema AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/accountingSchema

PUT Set BusinessParty AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/businessParty

PUT Set CashFlowItem AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/cashFlowItem

PUT Set ChartOfAccount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/chartOfAccount

PUT Set Company AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/company

PUT Set Currency AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/currency

PUT Set Description AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/description

PUT Set DimensionAllocation AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/dimensionAllocation

PUT Set DimensionSet AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/dimensionSet

PUT Set Discount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/discount

PUT Set DocumentDate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/documentDate

PUT Set DueDate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/dueDate

PUT Set ExchangeRate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/exchangeRate

PUT Set ExchangeRateDate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/exchangeRateDate

PUT Set ExchangeRateDifferencesBase AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/exchangeRateDifferencesBase

PUT Set ExchangeRateDifferencesReporting AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/exchangeRateDifferencesReporting

PUT Set FinancialAccount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/financialAccount

PUT Set FinancialArea AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (enum FinancialArea) The request body should contain the new value for the attribute.
See FinancialArea.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/financialArea

PUT Set FinancialYear AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/financialYear

PUT Set GLAccount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/gLAccount

PUT Set IBAN AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/iBAN

PUT Set IsActive AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/isActive

PUT Set IsReversal AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/isReversal

PUT Set Item AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/item

PUT Set JournalNumber AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/journalNumber

PUT Set JournalType AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/journalType

PUT Set Ledger AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/ledger

PUT Set Nature AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/nature

PUT Set Note AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/note

PUT Set OpenItemManaged AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/openItemManaged

PUT Set Party AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/party

PUT Set PartyAccountingSchema AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/partyAccountingSchema

PUT Set PartyTaxId AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/partyTaxId

PUT Set PaymentInstruction AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/paymentInstruction

PUT Set PaymentMethod AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/paymentMethod

PUT Set PaymentReference AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/paymentReference

PUT Set PaymentTerm AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/paymentTerm

PUT Set Period AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/period

PUT Set PostingDate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/postingDate

PUT Set PostingKey AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/postingKey

PUT Set Quantity AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/quantity

PUT Set ReconciliationId AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/reconciliationId

PUT Set ReferencePosting AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/referencePosting

PUT Set ReportingExchangeRate AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/reportingExchangeRate

PUT Set RoundingDifferencesBase AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/roundingDifferencesBase

PUT Set RoundingDifferencesReporting AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/roundingDifferencesReporting

PUT Set SettledByPosting AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/settledByPosting

PUT Set SourceDoc AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/sourceDoc

PUT Set SourceDocId AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/sourceDocId

PUT Set SourceDocLine AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/sourceDocLine

PUT Set SourceLineId AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/sourceLineId

PUT Set SourceSchemaEntity AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/sourceSchemaEntity

PUT Set Swift AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/swift

PUT Set TaxExclusiveAmount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/taxExclusiveAmount

PUT Set TaxSettlement AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/taxSettlement

PUT Set TaxTotal AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/taxTotal

PUT Set TaxTypeCode AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/taxTypeCode

PUT Set TotalAmount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/totalAmount

PUT Set TotalBase AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/totalBase

PUT Set TotalReporting AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/totalReporting

PUT Set Unit AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /financialCore/accountPostings/{companyKey}/{postingKey}/unit

PUT Set WithholdingTaxAmount AccountPosting

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

The following elements are required:

postingKey (int) The posting's key.
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 /financialCore/accountPostings/{companyKey}/{postingKey}/withholdingTaxAmount

DELETE Operations

DELETE AccountPosting by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /financialCore/accountPostings/{id}

DELETE AccountPosting by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
postingKey (int) The posting's key.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /financialCore/accountPostings/{companyKey}/{postingKey}

Resources


AccountPostingResource

The following elements are required:

postingKey (int) The posting's key.
documentDate (DateTime) The document date of the original document.
postingDate (DateTime) The posting date of the original document.
totalAmount (MoneyResource) The total amount of the original document.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The tax exclusive amount of the original document.
See MoneyResource .
taxTotal (MoneyResource) The tax total of the original document.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The withholding tax of the original document.
See MoneyResource .
exchangeRate (decimal) The exchange rate from transaction currency to base currency of the original document.
exchangeRateDifferencesBase (decimal) The exchange rate differences between original document and settlement document (receipt/payment) for base currency.
exchangeRateDifferencesReporting (decimal) The exchange rate differences between original document and settlement document (receipt/payment) for reporting currency.
discount (MoneyResource) The discount given in the settlement document.
See MoneyResource .
sourceDoc (string) The original document identification.
sourceDocId (Guid) The original document ID.
currency (string) The currency of the posting.
sourceSchemaEntity (string) The source schema entity.
company (string) The company of the transaction.
roundingDifferencesBase (decimal) The rounding differences between original document and settlement document (receipt/payment) for base currency.
roundingDifferencesReporting (decimal) The rounding differences between original document and settlement document (receipt/payment) for reporting currency.
chartOfAccount (string) The chart of accounts of the company.
gLAccount (string) The GL account of the transaction.
ledger (string) The ledger of the transaction.
journalType (string) The journal type assigned to the source doc.
journalNumber (int) The journal number assigned to the source doc.
financialYear (string) The financial year of the posting.
period (int) The financial period of the posting.
totalBase (decimal) The total amount in base currency.
totalReporting (decimal) The total amount in reporting currency.

The following elements are optional:

description (string) A description for the posting.
exchangeRateDate (DateTime) The date of the exchange rate of the original document.
dueDate (DateTime) The due date of the original document.
note (string) The reference of the posting of the original document.
openItemManaged (bool) For open items in customers/vendor accounts this flag is set to true, otherwise it's false.
sourceLineId (Guid) The source doc line ID.
sourceDocLine (int) The source doc line identification.
cashFlowItem (string) The cash flow classification. (For bank and petty cash postings only).
paymentTerm (string) The payment terms for the posting. Only to be filled for open items postings.
financialAccount (string) The bank account of the settlement. Only to be filled if the GL account is of subledger bank.
party (string) The party of the posting. Only to be filled if the GL account is of subledger vendor or customer.
paymentMethod (string) The payment method of the transaction.
accountingSchema (enum AccountingSchema) The associated account schema.
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The party accounting organization method. The party organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
financialArea (enum FinancialArea) The financial area where the open item comes from (purchases, sales or accounting).
See FinancialArea.
referencePosting (string) For settled postings it's assigned this field what open item is beeing settled.
settledByPosting (string) For open items when completelly settled it's assigned to this field the ID of the last posting that settled it.
reportingExchangeRate (decimal) The exchange rate between transaction currency and reporting currency.
dimensionSet (string) The dimension set of the transaction.
unit (string) For stock movements the unit is filled.
quantity (decimal) For stock movements the quantity is filled.
isReversal (bool) Flag used in the reversal process in the journal entry document.
item (string) For stock movements the item is filled.
nature (enum AccountingNature) The nature of the account posting.
See AccountingNature.
taxSettlement (Guid) Identifies the tax settlement document that processed this posting.
paymentReference (string) The payment reference is the document number associated to the payment issued.
reconciliationId (Guid) Identifies the bank reconciliation document that processed this posting.
businessParty (string) The business party is the party was the document issued.
swift (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The financial account's International Bank Account Number.
paymentInstruction (string) The Payment authorization given by the party.
bankOrderId (Guid) Identifies the bank order document that processed this posting.
paymentBatchId (Guid) Identifies the payment batch document that processed this posting.
partyTaxId (string) The party tax id of the posting.
taxTypeCode (string) Tax Type.
autonomousTaxationId (Guid) Identifies the autonomous taxation document that processed this posting.
dimensionAllocation (string) Dimension Allocation.


ApiAccountPostingResource

The following elements are required:

postingKey (int) The posting's key.
documentDate (DateTime) The document date of the original document.
postingDate (DateTime) The posting date of the original document.
totalAmount (MoneyResource) The total amount of the original document.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The tax exclusive amount of the original document.
See MoneyResource .
taxTotal (MoneyResource) The tax total of the original document.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The withholding tax of the original document.
See MoneyResource .
exchangeRate (decimal) The exchange rate from transaction currency to base currency of the original document.
exchangeRateDifferencesBase (decimal) The exchange rate differences between original document and settlement document (receipt/payment) for base currency.
exchangeRateDifferencesReporting (decimal) The exchange rate differences between original document and settlement document (receipt/payment) for reporting currency.
discount (MoneyResource) The discount given in the settlement document.
See MoneyResource .
sourceDoc (string) The original document identification.
sourceDocId (Guid) The original document ID.
currency (string) The currency of the posting.
sourceSchemaEntity (string) The source schema entity.
company (string) The company of the transaction.
roundingDifferencesBase (decimal) The rounding differences between original document and settlement document (receipt/payment) for base currency.
roundingDifferencesReporting (decimal) The rounding differences between original document and settlement document (receipt/payment) for reporting currency.
chartOfAccount (string) The chart of accounts of the company.
gLAccount (string) The GL account of the transaction.
ledger (string) The ledger of the transaction.
journalType (string) The journal type assigned to the source doc.
journalNumber (int) The journal number assigned to the source doc.
financialYear (string) The financial year of the posting.
period (int) The financial period of the posting.
totalBase (decimal) The total amount in base currency.
totalReporting (decimal) The total amount in reporting currency.

The following elements are optional:

description (string) A description for the posting.
exchangeRateDate (DateTime) The date of the exchange rate of the original document.
dueDate (DateTime) The due date of the original document.
note (string) The reference of the posting of the original document.
openItemManaged (bool) For open items in customers/vendor accounts this flag is set to true, otherwise it's false.
sourceLineId (Guid) The source doc line ID.
sourceDocLine (int) The source doc line identification.
cashFlowItem (string) The cash flow classification. (For bank and petty cash postings only).
paymentTerm (string) The payment terms for the posting. Only to be filled for open items postings.
financialAccount (string) The bank account of the settlement. Only to be filled if the GL account is of subledger bank.
party (string) The party of the posting. Only to be filled if the GL account is of subledger vendor or customer.
paymentMethod (string) The payment method of the transaction.
accountingSchema (enum AccountingSchema) The associated account schema.
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The party accounting organization method. The party organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
financialArea (enum FinancialArea) The financial area where the open item comes from (purchases, sales or accounting).
See FinancialArea.
referencePosting (string) For settled postings it's assigned this field what open item is beeing settled.
settledByPosting (string) For open items when completelly settled it's assigned to this field the ID of the last posting that settled it.
reportingExchangeRate (decimal) The exchange rate between transaction currency and reporting currency.
dimensionSet (string) The dimension set of the transaction.
unit (string) For stock movements the unit is filled.
quantity (decimal) For stock movements the quantity is filled.
isReversal (bool) Flag used in the reversal process in the journal entry document.
item (string) For stock movements the item is filled.
nature (enum AccountingNature) The nature of the account posting.
See AccountingNature.
taxSettlement (Guid) Identifies the tax settlement document that processed this posting.
paymentReference (string) The payment reference is the document number associated to the payment issued.
reconciliationId (Guid) Identifies the bank reconciliation document that processed this posting.
businessParty (string) The business party is the party was the document issued.
swift (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The financial account's International Bank Account Number.
paymentInstruction (string) The Payment authorization given by the party.
partyTaxId (string) The party tax id of the posting.
taxTypeCode (string) Tax Type.
dimensionAllocation (string) Dimension Allocation.


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.



Enumerations


AccountingNature

1 Debit
2 Credit


AccountingSchema

1 Accrual Acrrual Accounting Schema.
2 Cash


FinancialArea

1 AccountsReceivable
2 AccountsPayable
3 Accounting