GET /afps

Summary

List AfP

URL Parameters

• None

Query Parameters

Name	Type	Required	Description
company	string	No	Filter 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.
page	integer	No	Page number (default 1)
limit	integer	No	Records per page (default 50, max 200)
status	enum(pending, confirmed)	No	Filter by AfP status
project	string	No	Filter by project id
agency	string	No	Filter by agency id
afpType	enum(supplierToClient, supplierToMsp, mspToClient)	No	Filter by AfP flow type
mspInvoiceType	enum(receivable, payable)	No	Filter by MSP AfP subtype
query	string	No	Case-insensitive search against AfP reference, contextual company/project/supplier/MSP names, and linked timesheet references
dateField	enum(createdAt, confirmedDate, due, weekEnding)	No	Date field that from/to apply to. Default: createdAt.
from	string	No	Date filter start (YYYY-MM-DD); applies to dateField
to	string	No	Date filter end (YYYY-MM-DD); applies to dateField
sortBy	enum(createdAt, updatedAt, invoiceRef, due, weekEnding, confirmedDate)	No	Sort field
sortOrder	enum(asc, desc)	No	Sort direction
fields	string	No	Comma-separated list of response fields or dot-path nested fields to return

Request Example

cURL

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

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/afps?status=pending",
  {
    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": "pending",
      "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": null,
      "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-08T18:05:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 1
  }
}

Errors

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