Bank Accounting | Reconciliation
The Reconciliations end point is used to record all business transactions and events in the bank accounting reconciliations.
Overview
| URL | api/{tenantKey}/{orgKey}/bankAccounting/reconciliations |
| Methods Supported | GET, POST, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- DELETE:
All Resources
This service uses the following resources:
GET Reconciliations
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See ReconciliationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations
GET /bankAccounting/reconciliations
GET Reconciliations (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 ReconciliationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations?page={page}&pageSize={pageSize}
GET /bankAccounting/reconciliations?page={page}&pageSize={pageSize}
GET Reconciliation 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 ReconciliationResource. |
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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{id}
GET /bankAccounting/reconciliations/{id}
GET Reconciliation by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation Key. |
Response:
| When successful, the response body contains the entity record. See ReconciliationResource. |
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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}
GET /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}
GET Print Reconciliation 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{id}/print?template={template}
GET /bankAccounting/reconciliations/{id}/print?template={template}
GET Print Reconciliation by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/print
GET /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/print
GET Original Print ReconciliationOriginal 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{id}/printOriginal?template={template}
GET /bankAccounting/reconciliations/{id}/printOriginal?template={template}
GET Original Print Reconciliation by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/printOriginal
GET /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/printOriginal
POST Reconciliations
Creates a new entity record.
The following elements are required:
| reconciliationResource | (ApiReconciliationResource) The request body should contain the entity record that should be created. See ApiReconciliationResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
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 ApiReconciliationResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations
POST /bankAccounting/reconciliations
PUT Set Custom Attribute Reconciliation
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation Key. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/{customAttributeName}
PUT /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/{customAttributeName}
PUT Set Custom Attribute ReconciliationLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation Key. |
| lineId | (string) The detail identifier. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/reconciliationLines/{lineId}/{customAttributeName}
PUT /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}/reconciliationLines/{lineId}/{customAttributeName}
DELETE Reconciliation 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{id}
DELETE /bankAccounting/reconciliations/{id}
DELETE Reconciliation by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| reconciliationKey | (string) Reconciliation 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:
api/{tenantKey}/{orgKey}/bankAccounting/reconciliations/{companyKey}/{reconciliationKey}
DELETE /bankAccounting/reconciliations/{companyKey}/{reconciliationKey}
Resources
ApiReconciliationReconciliationLinesResource
The following elements are required:
| currency | (string) Document reconciliated currency.(ex:€). |
| creditAmount | (MoneyResource) Document reconciliated credit amount.
See MoneyResource . |
| debitAmount | (MoneyResource) Document reconciliated debit amount.
See MoneyResource . |
| accountPosting | (string) Document reconciliated account posting. |
The following elements are optional:
| documentDate | (DateTime) Document reconciliated date. |
| sourceDocId | (Guid) Document reconciliated id. |
| sourceDoc | (string) Document reconciliated. |
| note | (string) Document reconciliated note. |
| sourceSchemaEntityId | (Guid) Document reconciliated schema entity id. |
| paymentMethod | (string) Document reconciliated payment method(ex: NUM). |
| party | (string) Document reconciliated party. |
| paymentReference | (string) Document reconciliated payment reference. |
ApiReconciliationResource
The following elements are required:
| reconciliationKey | (string) Reconciliation Key. |
| documentDate | (DateTime) Reconciliation Date. |
| bankBalance | (MoneyResource) Reconciliation bank balance.
See MoneyResource . |
| reconciliatedAmount | (MoneyResource) Reconciliated.
See MoneyResource . |
| financialAccount | (string) FinancialAccount(ex: CGDDO). |
| currency | (string) Reconciliation currency. |
| company | (string) The company. |
| accountBalance | (MoneyResource) Financial Account balance.
See MoneyResource . |
The following elements are optional:
| postingDate | (DateTime) Reconciliation Posting Date. |
| remarks | (string) Reconciliation remarks. |
| note | (string) Reconciliation note. |
| isPrinted | (bool) Flag to know if it was printed. |
| reconciliationLines | (List of ApiReconciliationReconciliationLinesResource) Reconciliation lines.
See ApiReconciliationReconciliationLinesResource. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
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.
ReconciliationLineResource
The following elements are required:
| currency | (string) Document reconciliated currency.(ex:€). |
| creditAmount | (MoneyResource) Document reconciliated credit amount.
See MoneyResource . |
| debitAmount | (MoneyResource) Document reconciliated debit amount.
See MoneyResource . |
| accountPosting | (string) Document reconciliated account posting. |
The following elements are optional:
| documentDate | (DateTime) Document reconciliated date. |
| sourceDocId | (Guid) Document reconciliated id. |
| sourceDoc | (string) Document reconciliated. |
| note | (string) Document reconciliated note. |
| sourceSchemaEntityId | (Guid) Document reconciliated schema entity id. |
| paymentMethod | (string) Document reconciliated payment method(ex: NUM). |
| party | (string) Document reconciliated party. |
| paymentReference | (string) Document reconciliated payment reference. |
ReconciliationResource
The following elements are required:
| reconciliationKey | (string) Reconciliation Key. |
| documentDate | (DateTime) Reconciliation Date. |
| bankBalance | (MoneyResource) Reconciliation bank balance.
See MoneyResource . |
| reconciliatedAmount | (MoneyResource) Reconciliated.
See MoneyResource . |
| financialAccount | (string) FinancialAccount(ex: CGDDO).
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
| currency | (string) Reconciliation currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| company | (string) The company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| accountBalance | (MoneyResource) Financial Account balance.
See MoneyResource . |
The following elements are optional:
| postingDate | (DateTime) Reconciliation Posting Date. |
| remarks | (string) Reconciliation remarks. |
| note | (string) Reconciliation note. |
| isPrinted | (bool) Flag to know if it was printed. |
| reconciliationLines | (List of ReconciliationLineResource) Reconciliation lines.
See ReconciliationLineResource. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
| isReprinted | (bool) Indicates if the document has been reprinted. Internally determined. |
| isSigned | (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined. |