Notification

Retrieves the collection of Invoice notifications.

Retrieve the collection of notifications for a given invoice. You can have the notification message in JSON format or the original XML by sending the Accept HTTP header to either application/json or application/xml

SecurityBearer
Request
path Parameters
uuid
required
string
Responses
200

Notification collection response

get/invoices/{uuid}/notifications
Request samples
Response samples
[
  • {
    }
]

Setup the downloaded flag for a collection of notification.

Setup the downloaded flag for a collection of notification.
Note: the downloaded flag is automatically set when a notification is successfully received with the web-hook

SecurityBearer
Request
Request Body schema:

The new DownloadedEntity resource

uuids
Array of strings
downloaded
any
Responses
200

The downloaded flag has been set

400

Invalid input

404

Resource not found

post/notifications/downloaded
Request samples
{
  • "uuids": [
    ],
  • "downloaded": null
}

Retrieves a single notification.

Retrieve a single notification by its uuid. You can have the notification message in JSON format or the original XML by sending the Accept HTTP header to either application/json or application/xml

SecurityBearer
Request
path Parameters
uuid
required
string
Responses
200

Notification resource response

404

Resource not found

get/notifications/{uuid}
Request samples
Response samples
{
  • "uuid": "string",
  • "invoice_uuid": "string",
  • "created_at": "string",
  • "type": "string",
  • "message": "string",
  • "downloaded": true,
  • "downloaded_at": "2019-08-24T14:15:22Z",
  • "file_name": "string"
}