Payment Received Notification

The Payment Received notification is triggered when a payment has been successfully booked and matched to an order or invoice in Accounting as a Service. This notification helps you tracking which orders have been fully or partially paid. Payments could come from settlement files or bank transfers from bank account statements. The notification is triggered daily and provides detailed information on the payment and any remaining balance on the order.

Key benefits for you

This notification can be utilized for various business purposes:

  • Payment Updates: Get notified whenever a payment is successfully matched to an order or invoice, allowing you to track customer payments in real-time.
  • Payment Status for Customer Service: Use the information to update your CRM or My Account pages, letting customers know the status of their payments.
  • Automated Order Processing: Trigger fulfillment or shipment processes once the prepayment or other forms of payment have been received.
  • Tracking Partial Payments: Keep track of partial payments and ensure that all invoices are fully paid before fulfilling or closing orders.

Setting up the notification

To register to this notification, please look in the general notifications-page using accounting/paymentReceived

The follow-up processes depend on what you want to do with the data:

  • Save the data for your CRM Tool or My Account Pages
  • Initiate shipment (e.g. in case of pre-payment)

Technical Details

Trigger Events:

The Payment Received notification is triggered under the following conditions:

  1. Accounting as a Service receives the payment from settlement files or bank account statements.
  2. Accounting as a Service successfully matches the payment to the open amount for the respective order or invoice.

The notification is triggered once a day, summarizing the payments received and matched for each order or invoice.

Note: If an order has multiple invoices or partial cancellations, the payments may be split across multiple notifications, each referring to different invoice numbers.

Example full payment:

{
  "type": "accounting/paymentReceived",
  "parameters": {
    "businessCode": "1004",
    "companyCode": "1004",
    "currency": "EUR",
    "customerNumber": "CUS19006768",
    "fiscalYear": 2024,
    "invoiceReference": "INVO90006768",
    "orderAmount": 450.0,
    "orderReference": "ORD-9005985",
    "paidAmount": 450.0,
    "paymentDocument": "200400001208",
    "remainingAmount": 0.0,
    "tolerance": 0.0,
    "transactionId": "PaymentInformation-1004-0F5CAC7922G61EDF9EB010962B994489"
  }
}

Example partial payment:

{
  "type": "accounting/paymentReceived",
  "parameters": {
    "businessCode": "1004",
    "companyCode": "1004",
    "currency": "EUR",
    "customerNumber": "CUS9006771",
    "fiscalYear": 2024,
    "invoiceReference": "INV-0006771",
    "orderAmount": 450.0,
    "orderReference": "ORD-4689305987",
    "paidAmount": 445.0,
    "paymentDocument": "307000001973",
    "remainingAmount": 5.0,
    "tolerance": 0.0,
    "transactionId": "PaymentInformation-1004-0F5CAC7922F21EDF4PB0D0D06C4CCEFF"
  }
}

Field Descriptions

Please look here for the details of the Payment Received Notification.