GET /afps/{id}

Summary

Get AfP

URL Parameters

Name	Type	Required	Description
id	string	Yes	AfP id or nanoid

Query Parameters

• None

Request Example

cURL

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

JavaScript

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

const json = await response.json();

Response Fields

Field	Type	Description
afpType	string	AfP flow type
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 AfP was marked confirmed/paid
createdAt	string	Creation timestamp
due	string	AfP due date in ISO 8601 date-time format
files	object	File URLs. Child attributes: afp, timesheetSnapshot
id	string	AfP id
msp	object	Returned when present. Show child attributes id string - MSP id name string - MSP name
mspInvoiceType	string	MSP AfP 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
projects	array	Project references with id and name
reference	string	AfP reference
status	string	AfP status
timesheets	array	Linked timesheets with id and reference
updatedAt	string	Last update timestamp
values	object	Show child attributes grossHours number netHours number subtotal number vat number total number cis number finalTotal number expenses number creditNotes number netValue number
weekEnding	string	Week ending date in ISO 8601 date-time format

Response Example (200)

{
  "success": true,
  "data": {
    "id": "67bc36db80a1616ec3f4b101",
    "reference": "AFP-1044",
    "status": "confirmed",
    "company": {
      "id": "67bc36db80a1616ec3f47001",
      "name": "Requidex Construction Ltd"
    },
    "agency": {
      "id": "67bc36db80a1616ec3f47101",
      "name": "Northline Labour Desk"
    },
    "projects": [
      {
        "id": "67bc36db80a1616ec3f47011",
        "name": "Northern Rail Electrification"
      }
    ],
    "afpType": "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": {
      "afp": "https://files.requidex.com/invoices/AFP-1044.pdf",
      "timesheetSnapshot": "https://files.requidex.com/invoices/AFP-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 Status	Meaning
401	Missing, invalid, revoked, or expired API key
403	Forbidden due to scope or IP restrictions
404	AfP not found
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Unexpected internal error