Skip to main content

List Invoices

GET/invoices

Summary​

Returns a paginated list of invoices available to the API key, with filters for company, agency, status, type, reference, and relevant dates.

URL Parameters​

  • None

Query Parameters​

NameTypeRequiredDescription
companystringNoFilter by company id(s). Pass a single id or comma-separated ids. 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
dateFieldenum(createdAt, confirmedDate, due, weekEnding)NoDate field that from/to apply to. Default: createdAt.
fromstringNoDate filter start (YYYY-MM-DD); applies to dateField
tostringNoDate filter end (YYYY-MM-DD); applies to dateField
sortByenum(createdAt, updatedAt, invoiceRef, due, weekEnding, confirmedDate)NoSort field
sortOrderenum(asc, desc)NoSort direction
fieldsstringNoComma-separated list of response fields or dot-path nested fields to return

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
agencyobject
Show child attributes
  • id string - Agency id
  • name string - Agency name
companyobject
Show child attributes
  • id string - Company id
  • name string - Company name
confirmedByobjectReturned when present.
Show child attributes
  • id string - User id
  • name string - User name
confirmedDatestringTimestamp when the invoice was marked confirmed/paid
createdAtstringCreation timestamp
duestringInvoice due date in ISO 8601 date-time format
filesobjectFile URLs.
Show child attributes
  • invoice string / null - Invoice PDF URL
  • timesheetSnapshot string / null - Timesheet snapshot URL
idstringInvoice id
invoiceTypestringInvoice flow type
mspobjectReturned when present.
Show child attributes
  • id string - MSP id
  • name string - MSP name
mspInvoiceTypestringMSP invoice subtype when applicable
paymentobjectReturned when present.
Show child attributes
  • reference string - Payment reference
  • paymentDate string - Payment date in ISO 8601 date-time format
  • file object, optional - Payment attachment
    Show child attributes
    • fileName string - Original filename
    • url string - Download URL; Requidex-hosted S3 URLs expire after five minutes
    • created string - Attachment creation timestamp
projectsarrayProject references with id and name
reasonstringReturned when present. Ad hoc invoice reason
commentsstringReturned when present. Ad hoc invoice comments
referencestringInvoice reference
statusstringInvoice status
timesheetsarrayLinked timesheets with id and reference
updatedAtstringLast update timestamp
valuesobject
Show child attributes
  • grossHours number - Gross hours recorded on the invoice
  • netHours number - Net hours recorded on the invoice
  • subtotal number - Invoice amount before VAT, CIS deductions, and margin adjustments
  • vat number - VAT amount applied to the invoice
  • total number - Subtotal plus VAT, before CIS deductions and margin adjustments
  • cis number - Construction Industry Scheme (CIS) deduction amount
  • cisRate number - CIS deduction rate as a percentage, for example 20 for 20%
  • vatRate number - VAT rate as a percentage, for example 20 for 20%
  • finalTotal number - Invoice total after CIS deductions and any margin adjustments, before credit notes
  • expenses number - Expense amount included in the invoice
  • creditNotes number - Total credit-note amount applied to the invoice
  • netValue number - Invoice amount remaining after applied credit notes are deducted from finalTotal
vatToBeAppliedbooleanReturned when present. Whether VAT was requested for an ad hoc invoice before other VAT rules were applied
weekEndingstringWeek ending date in ISO 8601 date-time format

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,
"reason": "Weekly labour",
"comments": "Please process",
"vatToBeApplied": true,
"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,
"cisRate": 0,
"vatRate": 20,
"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
}
}

MCP Tool​

The MCP server exposes this operation as open_api_list_invoices with the inputs company, page, limit, status, project, agency, invoiceType, mspInvoiceType, query, dateField, from, to, sortBy, sortOrder, and fields.

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