GET /afps/payment-notices/{id}

Summary

Returns one payment notice by its id or internal nanoid, including its related application for payment, values, status, and issue details.

URL Parameters

Name	Type	Required	Description
id	string	Yes	Payment notice id or nanoid

Query Parameters

• None

Request Example

cURL

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

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/afps/payment-notices/{id}", {
  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": "processed",
    "afp": {
      "id": "67bc36db80a1616ec3f4b101",
      "reference": "AFP-1044"
    },
    "company": {
      "id": "67bc36db80a1616ec3f47001",
      "name": "Requidex Construction Ltd"
    },
    "agency": {
      "id": "67bc36db80a1616ec3f47101",
      "name": "Northline Labour Desk"
    },
    "approvedAmount": 1350,
    "disputedAmount": 0,
    "comments": "Accepted in full.",
    "processedDate": "2026-03-25T12:00:00.000Z",
    "processedFile": {
      "fileName": "AFP-1044-payment-notice.pdf",
      "url": "https://files.requidex.com/payment-notices/AFP-1044-payment-notice.pdf",
      "created": "2026-03-25T12:01:00.000Z"
    },
    "cancellationComments": null,
    "createdAt": "2026-03-20T09:15:00.000Z",
    "updatedAt": "2026-03-25T12:01:00.000Z"
  }
}

Errors

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