Skip to main content

GET /invoices/{id}

Summary

Get invoice

URL Parameters

NameTypeRequiredDescription
idstringYesInvoice id or nanoid

Query Parameters

  • None

Request Body Fields

No request body is accepted for this endpoint.

Request Example

curl -X GET 'https://api.requidex.com/api/open/v1/invoices/{id}' \
-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": "confirmed",
"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": "2026-03-25T12:00:00.000Z",
"confirmedBy": {
"id": "67bc36db80a1616ec3f47099",
"name": "Pat Taylor"
},
"payment": {
"reference": "PAY-2044",
"paymentDate": "2026-03-25T12:00:00.000Z"
},
"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-25T12:00:00.000Z"
}
}

Errors

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