Document Created - Notification

The Document Created notification informs you whenever a document (such as an invoice, dunning communication or end-customer booking confirmation) is successfully generated in Accounting as a Service. This notification includes essential metadata about the document, including its type, creation date, customer and order references, and a downloadable URL for accessing the document.

Key benefits for you

This notification can be utilized for various business purposes:

  • Access for Customer Service: Download and display the document to your customer service team in your CRM tool or provide it to your end-customers in the My-Account section.
  • Archiving: You can archive these documents on your side for future reference or compliance purposes.
  • Track Customer Communications: Know exactly what has been communicated to your end-customer, and what the content of emails or letters is.

Security Note: The provided URL must not be shared with end-customers directly. If you need to display the document, it is recommended to download it via the provided link and store it securely in your own system.

Setting up the notification

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

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

  • Download the document to display it in MyAccounting, CRM-Tools, etc.

The document is stored with a unique internal GUID, preventing unauthorized access through trial and error. The document remains stored in the optical archive on the Accounting side for as long as legally required, ensuring you can retrieve it at any time using the provided URL.

Technical Details

Trigger Events:

This notification is triggered when a document is created during key events such as:

  • Invoice generation during the invoicing process.
  • Dunning notice generation during the dunning run.
  • End customer booking confirmation when the document is created

Example for Invoice:

{
  "type": "accounting/documentCreated",
  "parameters": {
    "documents": [
      {
        "documentInformation": [
          {
            "documentCreationDate": "2024-09-19",
            "customerNumber": "200105432",
            "invoiceReference": "IDE99100008656",
            "orderReference": "0ODE99100006558"
          }
        ],
        "documentType": "INVOICE",
        "urlKey": "https://riverty-url/../FileSet('5035313435384F53384F534B545357584B4E')/$value"
      }
    ],
    "businessCode": "1000",
    "transactionId": "0F5CAC7922F21EEF9DD17B3E908E2FB6"
  },
  "timestamp": "2024-09-19T13:34:10.998395Z"
}

Example for Dunning:

{
  "parameters": {
    "documents": [
      {
        "documentInformation": [
          {
            "documentCreationDate": "2024-08-20",
            "customerNumber": "200099843",
            "dunningLevel": "01",
            "invoiceReference": "IES99100001093",
            "orderReference": "0OES99100001843"
          }
        ],
        "documentType": "DUNNING",
        "urlKey": "https://https://riverty-url/../FileSet('33553858304946464D32384D3047304E5748')/$value"
      }
    ],
    "businessCode": "1007",
    "transactionId": "6352984A5CD11EDF97EE76E6A41D982B"
  },
  "type": "accounting/documentCreated"
}

Field Descriptions

Please look here for the details of the Document Created Notification.

urlKey: A URL where you can download the document. This URL remains valid as long as the document is legally required to be stored. documentType: The following values are possible: INVOICE, DUNNING, BOOKING