Skip to main content

GET /invoices

Summary

List invoices

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
companystringNoFilter by company id. If omitted, data for all companies linked to the API key is returned.
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
statusenum(pending, confirmed)NoFilter by invoice status
projectstringNoFilter by project id
agencystringNoFilter by agency id
invoiceTypeenum(supplierToClient, supplierToMsp, mspToClient)NoFilter by invoice flow type
mspInvoiceTypeenum(receivable, payable)NoFilter by MSP invoice subtype
querystringNoCase-insensitive search against invoice reference, contextual company/project/supplier/MSP names, and linked timesheet references
fromstringNoCreated date filter start (YYYY-MM-DD)
tostringNoCreated date filter end (YYYY-MM-DD)
sortByenum(createdAt, updatedAt, invoiceRef, due, we, confirmedDate)NoSort field
sortOrderenum(asc, desc)NoSort direction

Request Body Fields

No request body is accepted for this endpoint.

Request Example

curl -X GET 'https://api.requidex.com/api/open/v1/invoices' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'

Response Fields

FieldTypeDescription
idstringInvoice id
referencestringInvoice reference
statusstringInvoice status
companyobject
Show child attributes
  • id string - Company id
  • name string - Company name
agencyobject
Show child attributes
  • id string - Agency id
  • name string - Agency name
mspobjectReturned when present.
Show child attributes
  • id string - MSP id
  • name string - MSP name
projectsarrayProject references with id and name
invoiceTypestringInvoice flow type
mspInvoiceTypestringMSP invoice subtype when applicable
weekEndingstringWeek ending date in ISO 8601 date-time format
duestringInvoice due date in ISO 8601 date-time format
confirmedDatestringTimestamp when the invoice was marked confirmed/paid
confirmedByobjectReturned when present.
Show child attributes
  • id string - User id
  • name string - User name
paymentobjectReturned when present.
Show child attributes
  • reference string - Payment reference
  • paymentDate string - Payment date in ISO 8601 date-time format
valuesobject
Show child attributes
  • grossHours number
  • netHours number
  • subtotal number
  • vat number
  • total number
  • cis number
  • finalTotal number
  • expenses number
  • creditNotes number
  • netValue number
filesobjectFile URLs. Child attributes: invoice, timesheetSnapshot
timesheetsarrayLinked timesheets with id and reference
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f4b001",
"reference": "RDX-NLD-I1044",
"status": "pending",
"company": {
"id": "67bc36db80a1616ec3f47001",
"name": "Requidex Construction Ltd"
},
"agency": {
"id": "67bc36db80a1616ec3f47101",
"name": "Northline Labour Desk"
},
"projects": [
{
"id": "67bc36db80a1616ec3f47011",
"name": "Northern Rail Electrification"
}
],
"invoiceType": "supplierToClient",
"mspInvoiceType": null,
"weekEnding": "2026-03-08T00:00:00.000Z",
"due": "2026-04-07T00:00:00.000Z",
"confirmedDate": null,
"values": {
"grossHours": 40,
"netHours": 37.5,
"subtotal": 1125,
"vat": 225,
"total": 1350,
"cis": 0,
"finalTotal": 1350,
"expenses": 125,
"creditNotes": 0,
"netValue": 1475
},
"files": {
"invoice": "https://files.requidex.com/invoices/INV-1044.pdf",
"timesheetSnapshot": "https://files.requidex.com/invoices/INV-1044-timesheets.pdf"
},
"timesheets": [
{
"id": "67bc36db80a1616ec3f4a001",
"reference": "TS-1044"
}
],
"createdAt": "2026-03-08T18:00:00.000Z",
"updatedAt": "2026-03-08T18:05:00.000Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1
}
}

Errors

HTTP StatusMeaning
401Missing, invalid, revoked, or expired API key
403Forbidden due to scope or IP restrictions
405Method not allowed on Open API routes
429Rate limit exceeded
500Unexpected internal error