Bank Accounting | Process Payment Batch Request
The Process Payment Batch Requests end point allows to process open payments and receivables to generate SEPA or Meal Card Files. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/bankAccounting/processPaymentBatchRequests |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
- POST:
- GET:
All Resources
This service uses the following resources:
GET Process Payment Batch Request
Returns the list of entity records that can be processed by the 'PaymentBatches' 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) The company code is the central organizational unit within the system. |
| documentDate | (DateTime) The document date. |
| currency | (string) The currency of the document. Must be the same as the financial account. |
| paymentMethod | (string) The payment method. |
The following elements are optional:
| financialAccount | (string) The the company financial account. This is a query string parameter. |
| note | (string) The note. This is a query string parameter. |
| dueDateFrom | (DateTime?) Due date from filter. This is a query string parameter. |
| dueDateUntil | (DateTime?) Due date until filter. This is a query string parameter. |
| total | (decimal?) Document total. Internally calculated. This is a query string parameter. |
| documentExchangeRate | (decimal?) The exchange rate of the document. This is a query string parameter. |
| sourceDocReference | (string) The source document reference is used to filter by the original document number. This is a query string parameter. |
| gLAccount | (string) The gl account filter. This is a query string parameter. |
| chartOfAccount | (string) The company chart of account. This is a query string parameter. |
| bankAccountType | (string) The bank account type where wil get the party bank information. This is a query string parameter. |
| onlyWithNoCredits | (bool?) Show only with no credits. This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See PaymentBatchRequestLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/processPaymentBatchRequests/{pageIndex}/{pageSize}?financialAccount={financialAccount}¬e={note}&dueDateFrom={dueDateFrom}&dueDateUntil={dueDateUntil}&total={total}&documentExchangeRate={documentExchangeRate}&sourceDocReference={sourceDocReference}&gLAccount={gLAccount}&chartOfAccount={chartOfAccount}&bankAccountType={bankAccountType}&onlyWithNoCredits={onlyWithNoCredits}
GET /bankAccounting/processPaymentBatchRequests/{pageIndex}/{pageSize}?financialAccount={financialAccount}¬e={note}&dueDateFrom={dueDateFrom}&dueDateUntil={dueDateUntil}&total={total}&documentExchangeRate={documentExchangeRate}&sourceDocReference={sourceDocReference}&gLAccount={gLAccount}&chartOfAccount={chartOfAccount}&bankAccountType={bankAccountType}&onlyWithNoCredits={onlyWithNoCredits}
POST Post Payment Batch Request
This operation allows to process open payments and receivables to generate SEPA or Meal Card Files.
The following elements are required:
| paymentBatchRequest | (PaymentBatchRequest) The resource to generate a payment batch. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/processPaymentBatchRequests/postPaymentBatchRequest
POST /bankAccounting/processPaymentBatchRequests/postPaymentBatchRequest
POST Process Payment Batch Request
Instructs the 'PaymentBatches' service to process the specified entity records.
The following elements are required:
| list | (PaymentBatchRequestLine) List of the entity records that should be processed. See PaymentBatchRequestLine. |
| 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}/bankAccounting/processPaymentBatchRequests/{companyKey}
POST /bankAccounting/processPaymentBatchRequests/{companyKey}
Resources
PaymentBatchRequest
The following elements are required:
| company | (string) The company code is the central organizational unit within the system. |
| documentDate | (DateTime) The document date. |
| currency | (string) The currency of the document. Must be the same as the financial account. |
| selectedCount | (int) The number of lines selected. |
| paymentMethod | (string) The payment method. |
The following elements are optional:
| financialAccount | (string) The the company financial account. |
| note | (string) The note. |
| dueDateFrom | (DateTime) Due date from filter. |
| dueDateUntil | (DateTime) Due date until filter. |
| total | (decimal) Document total. Internally calculated. |
| documentExchangeRate | (decimal) The exchange rate of the document. |
| sourceDocReference | (string) The source document reference is used to filter by the original document number. |
| gLAccount | (string) The gl account filter. |
| chartOfAccount | (string) The company chart of account. |
| bankAccountType | (string) The bank account type where wil get the party bank information. |
| onlyWithNoCredits | (bool) Show only with no credits. |
PaymentBatchRequestLine
The following elements are required:
| selected | (bool) If true the line is selected. Picking required. |
The following elements are optional:
| party | (string) The party designated in the account posting as the party to whom should be sent the receipt or payment. |
| sourceDoc | (string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Debit Notes). Internally determined. |
| postingDate | (DateTime) The posting date of the original document. |
| dueDate | (DateTime) The due date of the original document. |
| amount | (decimal) It indicates the total amount of the original document in the receipt currency. Internally determined. |
| open | (decimal) It indicates the current open amount of the original document in the receipt or payment. One original document can be partially settled over multiple receipts or payments. Internally determined. |
| discount | (decimal) The discount. |
| withholded | (decimal) It indicates the withholding tax amount (in the SEPA curreny) that will be settled by this SEPA. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. |
| transferAmount | (decimal) It indicates the transfer amount (in the SEPA currency). This amount is the original open amount deducted of the withholded tax amount (when applicable) and any financial discounts. |
| accountPostingId | (Guid) The unique identifier of then account posting for the line. Internally determined. |
| sourceDocId | (Guid) The unique identifier of the original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined. |
| swift | (string) The party swift bank information. |
| iBAN | (string) The party iban bank information. |
| paymentInstruction | (string) The party payment instruction bank information. |
| note | (string) The note. |
| sourceDocLine | (int) The source line index. |
| sourceDocLineId | (Guid) The source document line identifier document. |