GET
/
api
/
v1
/
invoices
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "invoiceNumber": 123,
      "user": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "fullName": "<string>",
        "companyIdentifier": "<string>",
        "companyName": "<string>",
        "companyAddress": "<string>",
        "companyRegNo": "<string>"
      },
      "profileExternal": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "companyIdentifier": "<string>",
        "companyName": "<string>",
        "companyAddress": "<string>",
        "customFieldValues": [
          "https://example.com/"
        ],
        "professionOrganisationRole": "<string>",
        "companyRegNo": "<string>",
        "status": "https://example.com/",
        "lastStatusUpdate": "2023-11-07T05:31:56Z",
        "fullName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "amount": 123,
      "invoicedFor": "<string>",
      "type": "<string>",
      "body": "<string>",
      "status": "<string>",
      "internalNotes": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "invoiceDate": "2023-11-07T05:31:56Z",
      "membershipStartDate": "2023-11-07T05:31:56Z",
      "membershipEndDate": "2023-11-07T05:31:56Z",
      "isMembership": true,
      "series": "<string>"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

​
page
integer
default:1

The collection page number

​
pagination
boolean

Enable or disable pagination

​
id
integer
​
id[]
integer[]
​
status
string
​
status[]
string[]
​
type
string
​
type[]
string[]
​
series
string
​
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
​
order[id]
enum<string>
default:asc
Available options:
asc,
desc
​
order[invoiceNumber]
enum<string>
default:asc
Available options:
asc,
desc
​
order[invoicedFor]
enum<string>
default:asc
Available options:
asc,
desc
​
order[amount]
enum<string>
default:asc
Available options:
asc,
desc
​
order[status]
enum<string>
default:asc
Available options:
asc,
desc
​
order[type]
enum<string>
default:asc
Available options:
asc,
desc

Response

200
application/ld+json

Invoice collection

The response is of type object.