Skip to content
Recruso API

List invoice methods

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

Returns every invoice method the platform publishes. How a client wants its invoices grouped. The values are Cost Centre, Employees, Job Category, PO Number Day/Rate, PO Order Number and Standard.

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. Use the id wherever a request asks for a invoice method — invoiceMethodId on CreateSite and invoiceMethodId on UpdateSite.

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

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Every invoice method the platform publishes.

object
invoiceMethods
required

The invoice methods. Never null.

Array<object>

One invoice method in a list.

object
id

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

integer format: int16
name

The invoice method name, as it appears in Recruso. Up to 30 characters. Unique across all invoice methods.

string
Example
{
  "invoiceMethods": [
    {
      "id": 1,
      "name": "Email"
    }
  ]
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}