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:
-
GET:
- GET AccountPostings
- GET AccountPostings (paged)
- GET AccountPosting by identifier
- GET AccountPosting by key
- GET Print AccountPosting by identifier
- GET Print AccountPosting by key
- GET Original Print AccountPostingOriginal by identifier
- GET Original Print AccountPosting by key
- GET Validate Existing Postings
- POST:
-
PUT:
- PUT Set IsActive AccountPosting
- PUT Set PostingKey AccountPosting
- PUT Set DocumentDate AccountPosting
- PUT Set PostingDate AccountPosting
- PUT Set Description AccountPosting
- PUT Set TotalAmount AccountPosting
- PUT Set TaxExclusiveAmount AccountPosting
- PUT Set TaxTotal AccountPosting
- PUT Set WithholdingTaxAmount AccountPosting
- PUT Set ExchangeRate AccountPosting
- PUT Set ExchangeRateDate AccountPosting
- PUT Set ExchangeRateDifferencesBase AccountPosting
- PUT Set ExchangeRateDifferencesReporting AccountPosting
- PUT Set DueDate AccountPosting
- PUT Set Discount AccountPosting
- PUT Set SourceDoc AccountPosting
- PUT Set Note AccountPosting
- PUT Set OpenItemManaged AccountPosting
- PUT Set SourceDocId AccountPosting
- PUT Set SourceLineId AccountPosting
- PUT Set SourceDocLine AccountPosting
- PUT Set CashFlowItem AccountPosting
- PUT Set Currency AccountPosting
- PUT Set PaymentTerm AccountPosting
- PUT Set FinancialAccount AccountPosting
- PUT Set SourceSchemaEntity AccountPosting
- PUT Set Party AccountPosting
- PUT Set PaymentMethod AccountPosting
- PUT Set Company AccountPosting
- PUT Set AccountingSchema AccountPosting
- PUT Set PartyAccountingSchema AccountPosting
- PUT Set FinancialArea AccountPosting
- PUT Set ReferencePosting AccountPosting
- PUT Set SettledByPosting AccountPosting
- PUT Set RoundingDifferencesBase AccountPosting
- PUT Set RoundingDifferencesReporting AccountPosting
- PUT Set ReportingExchangeRate AccountPosting
- PUT Set ChartOfAccount AccountPosting
- PUT Set GLAccount AccountPosting
- PUT Set DimensionSet AccountPosting
- PUT Set Ledger AccountPosting
- PUT Set JournalType AccountPosting
- PUT Set JournalNumber AccountPosting
- PUT Set Unit AccountPosting
- PUT Set Quantity AccountPosting
- PUT Set FinancialYear AccountPosting
- PUT Set Period AccountPosting
- PUT Set IsReversal AccountPosting
- PUT Set TotalBase AccountPosting
- PUT Set TotalReporting AccountPosting
- PUT Set Item AccountPosting
- PUT Set Nature AccountPosting
- PUT Set TaxSettlement AccountPosting
- PUT Set PaymentReference AccountPosting
- PUT Set ReconciliationId AccountPosting
- PUT Set BusinessParty AccountPosting
- PUT Set Swift AccountPosting
- PUT Set IBAN AccountPosting
- PUT Set PaymentInstruction AccountPosting
- PUT Set PartyTaxId AccountPosting
- PUT Set TaxTypeCode AccountPosting
- PUT Set DimensionAllocation AccountPosting
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
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 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 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 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 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 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 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 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 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:
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 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 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:
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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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:
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 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:
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.