Errors

The errors array within the web-hook payload plays critical role in identifying issues that arise during an event, associated with a Receivable. In certain scenarios, the errors array may capture multiple errors related to a single event.

Each error listed within the array gives detailed info on the specific issue, covering:

• message is a general description of the error, providing an overview of what went wrong
• propertyName field is included if the error is tied to a specific property of the Receivable. It helps in pinpointing the exact attribute of the transaction that encountered an issue, streamlining the troubleshooting process
• reasonCode is an identifier for the type of error encountered
• reason field elaborates on the specific reason behind the error, offering a clear explanation to aid in understanding and resolving the issue

{
        "message": "Unable to cancel Receivable with record number ad3400c3-7699-4aaa-8145-af2a61857304. The current status of Paid does not allow cancelation.",
        "statusId": 4,
        "eventReferenceId": "ad3400c3-7699-4aaa-8145-af2a61857304",
        "eventTimeStamp": "2024-03-27T11:21:10.4941794-04:00",
        "correlationId": "",
        "errorsAndNotices": {
          "errorFound": true,
          "errors": [
            {
              "message": "",
              "propertyName": "",
              "reasonCode": "",
              "reason": "Unable to cancel Receivable with record number ad3400c3-7699-4aaa-8145-af2a61857304. The current status of Paid does not allow cancelation."
            }
          ],
          "notices": []
        }
      }

Errors are triggered when an action fails to complete successfully. These are critical notifications that require immediate attention to resolve operational issues. Below are some of the common error codes and their descriptions.

Notices

Notices within the web-hook payload serve as informative messages that communicate positive events or non-critical information related to a Receivable.

Unlike errors, notices do not indicate problems but rather convey useful updated or confirmations about the processes associated with your payment.

The structure of the notices includes several key components designed o offer clarity and context:

• message field provides a concise yet informative description directly related to the notice, often summarizing the essence of the status update or the detail associated with the status change
• propertyName field identifies the specific attribute or aspect of the Receivable that the notice is related to
• reasonCode is a unique code that identifies the specific type of notice being communicated
• reason provides a clear description of the status changes and detailed explanation related to these changes

{
        "message": "Receivable with the record number 153c53e7-1c51-4f0a-a280-828a525467f8 has been created on 3/22/2024 9:47:37 AM",
        "statusId": 1,
        "eventReferenceId": "153c53e7-1c51-4f0a-a280-828a525467f8",
        "eventTimeStamp": "2024-03-22T09:47:37.3540714-04:00",
        "correlationId": "",
        "errorsAndNotices": {
          "errorFound": false,
          "errors": [],
          "notices": [
            {
              "message": "",
              "propertyName": "",
              "reasonCode": "",
              "reason": "Receivable with the record number 153c53e7-1c51-4f0a-a280-828a525467f8 has been created on 3/22/2024 9:47:37 AM"
            }
          ]
        }
      }

Notices provide additional information about a successful action, offering insights or warnings that do not necessarily indicate an error but may require attention or action.