Get Invoice

GET/invoices/{id}

Summary

Returns one invoice by its id or internal nanoid, including its parties, references, line values, totals, status, and relevant dates.

URL Parameters

Name	Type	Required	Description
id	string	Yes	Invoice id or nanoid

Query Parameters

• None

Request Example

cURL

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

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/invoices/{id}",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer <API_KEY>",
      Accept: "application/json",
    },
  },
);

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/invoices/{id}',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/invoices/{id}", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Field	Type	Description
agency	object	Show child attributes id string - Agency id name string - Agency name
company	object	Show child attributes id string - Company id name string - Company name
confirmedBy	object	Returned when present. Show child attributes id string - User id name string - User name
confirmedDate	string	Timestamp when the invoice was marked confirmed/paid
createdAt	string	Creation timestamp
due	string	Invoice due date in ISO 8601 date-time format
files	object	File URLs. Show child attributes invoice string / null - Invoice PDF URL timesheetSnapshot string / null - Timesheet snapshot URL
id	string	Invoice id
invoiceType	string	Invoice flow type
msp	object	Returned when present. Show child attributes id string - MSP id name string - MSP name
mspInvoiceType	string	MSP invoice subtype when applicable
payment	object	Returned 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
projects	array	Project references with id and name
reason	string	Returned when present. Ad hoc invoice reason
comments	string	Returned when present. Ad hoc invoice comments
reference	string	Invoice reference
status	string	Invoice status
timesheets	array	Linked timesheets with id and reference
updatedAt	string	Last update timestamp
values	object	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
vatToBeApplied	boolean	Returned when present. Whether VAT was requested for an ad hoc invoice before other VAT rules were applied
weekEnding	string	Week ending date in ISO 8601 date-time format

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,
    "reason": "Weekly labour",
    "comments": "Please process",
    "vatToBeApplied": true,
    "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,
      "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-25T12:00:00.000Z"
  }
}

MCP Tool

The MCP server exposes this operation as open_api_get_invoice with the input id.

Errors

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