GET /afps/payment-notices

Summary

List Payment Notices

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, processed, cancelled)	No	Filter by payment notice status
query	string	No	Case-insensitive search against payment notice reference, AfP reference, and notice comments
afp	string	No	Filter by AfP id
dateField	enum(createdAt, processedDate)	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, paymentNoticeRef, processedDate)	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/payment-notices?status=pending' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

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

const json = await response.json();

Response Fields

Field	Type	Description
afp	object	Linked AfP with id and reference
agency	object	Show child attributes id string - Agency id name string - Agency name
approvedAmount	number	Amount approved by the notice
cancellationComments	string	Cancellation comments when the notice was cancelled
comments	string	Free-text comments recorded on the notice
company	object	Show child attributes id string - Company id name string - Company name
createdAt	string	Creation timestamp
dispute	object	Returned when dispute details exist. Show child attributes comments string - Notice-level dispute comments disputedItems array - Disputed items with timesheet, expenseId, amount, and reason
disputedAmount	number	Amount disputed by the notice
id	string	Payment notice id
processedDate	string	Timestamp when the notice was marked processed
processedFile	object	Returned when a processed file is attached. Show child attributes fileName string - Processed notice file name url string - Processed notice file URL when available created string - Timestamp when the processed file was attached
reference	string	Payment notice reference
status	string	Payment notice status
updatedAt	string	Last update timestamp

Response Example (200)

{
  "success": true,
  "data": [
    {
      "id": "67bc36db80a1616ec3f4d001",
      "reference": "RDX-NLD-P1044",
      "status": "pending",
      "afp": {
        "id": "67bc36db80a1616ec3f4b101",
        "reference": "AFP-1044"
      },
      "company": {
        "id": "67bc36db80a1616ec3f47001",
        "name": "Requidex Construction Ltd"
      },
      "agency": {
        "id": "67bc36db80a1616ec3f47101",
        "name": "Northline Labour Desk"
      },
      "approvedAmount": 1225,
      "disputedAmount": 125,
      "comments": "Please see disputed item breakdown.",
      "dispute": {
        "comments": "One timesheet line is disputed pending review.",
        "disputedItems": [
          {
            "timesheet": {
              "id": "67bc36db80a1616ec3f4a001",
              "reference": "TS-1044"
            },
            "expenseId": null,
            "amount": 125,
            "reason": "Hours exceed authorised shift"
          }
        ]
      },
      "processedDate": null,
      "processedFile": null,
      "cancellationComments": null,
      "createdAt": "2026-03-20T09:15:00.000Z",
      "updatedAt": "2026-03-20T09:15: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