List client invoice types

GET

/v1/reference/client-invoice-types

curl --request GET \
  --url https://api2.recruso.co.uk/v1/reference/client-invoice-types \
  --header 'Authorization: <Authorization>'

• Production

Returns every client invoice type the platform publishes. The client endpoints take this vocabulary by name rather than by id: clientInvoiceType on create and update a client is matched against these names, and an unrecognised name returns 400 listing the accepted values.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. No endpoint published on this API takes a client invoice type id yet; the vocabulary is published so that its values are enumerable.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

Access. Requires an authenticated token. No further policy is applied.

Authorizations

• Bearer

Responses

200

OK

Media typeapplication/json

Every client invoice type the platform publishes.

object

clientInvoiceTypes

required

The client invoice types. Never null.

Array<object>

One client invoice type in a list.

object

id

The client invoice type’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16

name

The client invoice type name, as it appears in Recruso. Up to 50 characters. Unique across all client invoice types.

string

Example^generated

{
  "clientInvoiceTypes": [
    {
      "id": 1,
      "name": "example"
    }
  ]
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}