latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Invoice Notes

List invoice notes

Retrieve all invoice notes

get/invoice-notes

Query parameters

namestring

Search invoice notes by name

filtersobject

Filter invoice notes by query parameters.<br /> * <b>Example:</b> { "name[eq]" : "Late Payment" } to search for a note with that name.

sort[asc]'name'

Sort invoice notes in ascending order

sort[desc]'name'

Sort invoice notes in descending order

pageinteger

The particular page to return

per_pageinteger

The number of items per page. Default: 50, Limit: 200

Response

Successful operation

messagestring

Example response

{
  "message": "Invoice notes retrieved successfully.",
  "invoice_notes": [
    {
      "id": 1,
      "name": "Note 1",
      "description": "Thank you for your service"
    },
    {
      "id": 2,
      "name": "Note 2",
      "description": "Thank you for you business",
      "is_default": "true"
    }
  ]
}