Accounts Payable | Create Payment
The Process Open Item end point allows to process open items like sales memo or purchase invoice to payments. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/accountsPayable/processOpenItems |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Create Payment
Returns the list of entity records that can be processed by the 'Payments' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| company | (string) Company. |
| documentDate | (DateTime) Document Date. |
| documentExchangeRate | (decimal) Document Exchange Rate. |
| party | (string) Party. |
| currency | (string) Currency. |
| documentType | (string) Document Type. |
The following elements are optional:
| dueDateFrom | (DateTime?) Due Date From This is a query string parameter. |
| dueDateUntil | (DateTime?) Due Date Until This is a query string parameter. |
| paymentMethod | (string) Payment Method This is a query string parameter. |
| total | (decimal?) Total This is a query string parameter. |
| sourceDoc | (string) Source Doc This is a query string parameter. |
| financialAccount | (string) Financial Account This is a query string parameter. |
| sourceDocId | (Guid?) Source Doc Id This is a query string parameter. |
| sourceSchemaEntityId | (Guid?) Source Schema Entity Id This is a query string parameter. |
| gLAccount | (string) GL Account This is a query string parameter. |
| chartOfAccount | (string) Chart Of Account This is a query string parameter. |
| note | (string) Reference This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See OpenAccountPostingLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/processOpenItems/{pageIndex}/{pageSize}?dueDateFrom={dueDateFrom}&dueDateUntil={dueDateUntil}&paymentMethod={paymentMethod}&total={total}&sourceDoc={sourceDoc}&financialAccount={financialAccount}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}&gLAccount={gLAccount}&chartOfAccount={chartOfAccount}¬e={note}
GET /accountsPayable/processOpenItems/{pageIndex}/{pageSize}?dueDateFrom={dueDateFrom}&dueDateUntil={dueDateUntil}&paymentMethod={paymentMethod}&total={total}&sourceDoc={sourceDoc}&financialAccount={financialAccount}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}&gLAccount={gLAccount}&chartOfAccount={chartOfAccount}¬e={note}
POST Post Open Items Request
This operation allows create payments from memos and invoices.
The following elements are required:
| openAccountPosting | (OpenAccountPosting) The Open Account Posting represents the open items like memos and invoices. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/processOpenItems/postOpenItemsRequest
POST /accountsPayable/processOpenItems/postOpenItemsRequest
POST Create Payment
Instructs the 'Payments' service to process the specified entity records.
The following elements are required:
| list | (OpenAccountPostingLine) List of the entity records that should be processed. See OpenAccountPostingLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/accountsPayable/processOpenItems/{companyKey}
POST /accountsPayable/processOpenItems/{companyKey}
Resources
OpenAccountPosting
The following elements are required:
| company | (string) Company. |
| documentDate | (DateTime) Document Date. |
| documentExchangeRate | (decimal) Document Exchange Rate. |
| party | (string) Party. |
| currency | (string) Currency. |
| selectedCount | (int) Selected Count. |
| documentType | (string) Document Type. |
The following elements are optional:
| dueDateFrom | (DateTime) Due Date From. |
| dueDateUntil | (DateTime) Due Date Until. |
| paymentMethod | (string) Payment Method. |
| total | (decimal) Total. |
| sourceDoc | (string) Source Doc. |
| financialAccount | (string) Financial Account. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
| gLAccount | (string) GL Account. |
| chartOfAccount | (string) Chart Of Account. |
| note | (string) Reference. |
OpenAccountPostingLine
The following elements are required:
| selected | (bool) Selected. |
| documentDate | (DateTime) Document Date. |
The following elements are optional:
| sourceDoc | (string) Source Doc. |
| dueDate | (DateTime) Due Date. |
| paymentMethod | (string) Payment Method. |
| amount | (decimal) Amount. |
| open | (decimal) Open. |
| settled | (decimal) Settled. |
| discount | (decimal) Discount. |
| withholded | (decimal) Withholded. |
| accountPostingId | (Guid) Account Posting Id. |
| exchangeRate | (decimal) Exchange Rate. |
| natureId | (Guid) Nature Id. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceDocLine | (int) Source Doc Line. |
| sourceDocLineId | (Guid) Source Doc Line Id. |
| gLAccount | (string) GL Account. |
| chartOfAccount | (string) Chart Of Account. |
| note | (string) Reference. |
| originalOpen | (decimal) Original Open. |