Bank Accounting | Bank Order Status Report

The Bank Order Status Reports end point is used to import the response of your bank relative to the SEPA payments or receivables. This end poind will change the status of the Bank Order and this respective lines. RESERVED FOR INTERNAL USE.

Overview

URL	api/{tenantKey}/{orgKey}/bankAccounting/bankOrderStatusReports
Methods Supported	POST

All Operations

This service includes the following operations:

• POST:
  • POST Import

All Resources

This service uses the following resources:

• BankOrderStatusReport

POST Operations

POST Import

This operation is used to import the response of your bank relative to the SEPA payments or receivables. This end poind will change the status of the Bank Order and this respective lines. RESERVED FOR INTERNAL USE.

The following elements are required:

bankOrderStatusReport

(BankOrderStatusReport) BankOrderStatusReport.

Response:

When successful, the response body is empty.

Resource URL:

Resources

BankOrderStatusReport

The following elements are required:

messageId	(string) The SEPA Return unique identifier (issued by the bank).
fileCreationDate	(DateTimeOffset) File Creation Date.
originalBankOrderId	(string) The bank order id included in the original request (generated by the system). Crucial for finding the unique bank order request in the system.
originalMessageCode	(string) The original bank order request code (e.g. CCT: pain.001.001.03, CDD: pain.008.001.02).
originalTransactionsGroupId	(string) The original bank order request group of transactions identifier. Payment/Receive transaction orders are grouped by Entity. Each SepaReturnRequest contains info of only one group of 'Payment Information and Status' at a time. An OriginalPaymentStatusId must correspond to an entity (client/supplier) key in the system.

The following elements are optional:

originalTotalTransactions	(int) Total Number of transactions in the return file.
originalTotalAmount	(decimal) The original bank order request total amount (control sum).
originalTransactionsGroupTotalTransactions	(int) The original number of transactions for the OriginalPaymentStatusId group.
originalTransactionsGroupTotalAmount	(decimal) The group of transactions total amount (control sum).
transactionsGroupStatusCode	(string) Proprietary code indicating the current status of all transactions included in this group.