Bank Accounting | Create Reconciliation Request
The Process Reconciliation Requests end point is used to create bank accounting reconciliations. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/bankAccounting/processReconciliationRequests |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
- POST:
- GET:
All Resources
This service uses the following resources:
GET Create Reconciliation Request
Returns the list of entity records that can be processed by the 'Reconciliations' 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. |
| financialAccount | (string) Financial Account. |
| documentDate | (DateTime) Date. |
The following elements are optional:
| reconciliation | (string) Reconciliation This is a query string parameter. |
| bankBalance | (decimal?) Bank Balance This is a query string parameter. |
| accountBalance | (decimal?) Account Balance This is a query string parameter. |
| reconciliatedAmount | (decimal?) Reconciliated Amount This is a query string parameter. |
| nonReconciliatedAmount | (decimal?) Non Reconciliated Amount This is a query string parameter. |
| balance | (decimal?) Balance This is a query string parameter. |
| originalReconciliatedAmount | (decimal?) Original Reconciliated Amount This is a query string parameter. |
| originalNonReconciliatedAmount | (decimal?) Original Non Reconciliated Amount This is a query string parameter. |
| currency | (string) Currency This is a query string parameter. |
| note | (string) Reference This is a query string parameter. |
| startDate | (DateTime?) Start Date This is a query string parameter. |
| value | (int?) Value This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ReconciliationRequestDetail. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/processReconciliationRequests/{pageIndex}/{pageSize}?reconciliation={reconciliation}&bankBalance={bankBalance}&accountBalance={accountBalance}&reconciliatedAmount={reconciliatedAmount}&nonReconciliatedAmount={nonReconciliatedAmount}&balance={balance}&originalReconciliatedAmount={originalReconciliatedAmount}&originalNonReconciliatedAmount={originalNonReconciliatedAmount}¤cy={currency}¬e={note}&startDate={startDate}&value={value}
GET /bankAccounting/processReconciliationRequests/{pageIndex}/{pageSize}?reconciliation={reconciliation}&bankBalance={bankBalance}&accountBalance={accountBalance}&reconciliatedAmount={reconciliatedAmount}&nonReconciliatedAmount={nonReconciliatedAmount}&balance={balance}&originalReconciliatedAmount={originalReconciliatedAmount}&originalNonReconciliatedAmount={originalNonReconciliatedAmount}¤cy={currency}¬e={note}&startDate={startDate}&value={value}
POST Post Reconciliation Request
This operation allows create bank accounting reconciliations.
The following elements are required:
| reconciliationRequest | (ReconciliationRequest) ReconciliationRequest. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/processReconciliationRequests/postReconciliationRequest
POST /bankAccounting/processReconciliationRequests/postReconciliationRequest
POST Create Reconciliation Request
Instructs the 'Reconciliations' service to process the specified entity records.
The following elements are required:
| list | (ReconciliationRequestDetail) List of the entity records that should be processed. See ReconciliationRequestDetail. |
| 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/processReconciliationRequests/{companyKey}
POST /bankAccounting/processReconciliationRequests/{companyKey}
Resources
ReconciliationRequest
The following elements are required:
| selectedCount | (int) Selected Count. |
| company | (string) Company. |
| financialAccount | (string) Financial Account. |
| documentDate | (DateTime) Date. |
The following elements are optional:
| reconciliation | (string) Reconciliation. |
| bankBalance | (decimal) Bank Balance. |
| accountBalance | (decimal) Account Balance. |
| reconciliatedAmount | (decimal) Reconciliated Amount. |
| nonReconciliatedAmount | (decimal) Non Reconciliated Amount. |
| balance | (decimal) Balance. |
| originalReconciliatedAmount | (decimal) Original Reconciliated Amount. |
| originalNonReconciliatedAmount | (decimal) Original Non Reconciliated Amount. |
| currency | (string) Currency. |
| note | (string) Reference. |
| startDate | (DateTime) Start Date. |
| value | (int) Value. |
ReconciliationRequestDetail
The following elements are required:
| selected | (bool) Selected. |
| documentDate | (DateTime) Document Date. |
| sourceDoc | (string) Source Doc. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
The following elements are optional:
| paymentMethod | (string) Payment Method. |
| note | (string) Reference. |
| paymentReference | (string) Payment Reference. |
| party | (string) Party. |
| creditAmount | (decimal) Credit. |
| debitAmount | (decimal) Debit. |
| sourceDocId | (Guid) Source Doc Id. |
| accountPostingId | (Guid) Account Posting Id. |
| sourceDocLine | (int) Source Doc Line. |