GET /credit-notes/{id}

Summary

Get credit note

URL Parameters

Name	Type	Required	Description
id	string	Yes	Credit note id or nanoid

Query Parameters

• None

Request Body Fields

No request body is accepted for this endpoint.

Request Example

cURL

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

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/credit-notes/{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/credit-notes/{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/credit-notes/{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
id	string	Credit note id
reference	string	Credit note reference
status	string	Credit note status
company	object	Show child attributes id string - Company id name string - Company name
agency	object	Show child attributes id string - Agency id name string - Agency name
msp	object	Returned when present. Show child attributes id string - MSP id name string - MSP name
project	object	Returned when present. Show child attributes id string - Project id name string - Project name
invoiceType	string	Credit note flow type
mspInvoiceType	string	MSP credit note subtype when applicable
reason	string	Credit note reason
comments	string	Credit note comments
weekEnding	string	Returned when present. Week ending date in ISO 8601 date-time format
confirmedDate	string	Timestamp when the credit note was marked confirmed/processed
confirmedBy	object	Returned when present. Show child attributes id string - User id name string - User name
payment	object	Returned when present. Show child attributes reference string - Payment reference paymentDate string - Payment date in ISO 8601 date-time format
values	object	Show child attributes grossHours number netHours number subtotal number vat number total number cis number finalTotal number
files	object	File URLs. Child attributes: creditNote
invoice	object	Returned when present. Show child attributes id string - Invoice id reference string - Invoice reference
timesheet	object	Returned when present. Show child attributes id string - Timesheet id reference string - Timesheet reference
createdAt	string	Creation timestamp
updatedAt	string	Last update timestamp

Response Example (200)

{
  "success": true,
  "data": {
    "id": "67bc36db80a1616ec3f4c001",
    "reference": "RDX-NLD-C12",
    "status": "processed",
    "company": {
      "id": "67bc36db80a1616ec3f47001",
      "name": "Requidex Construction Ltd"
    },
    "agency": {
      "id": "67bc36db80a1616ec3f47101",
      "name": "Northline Labour Desk"
    },
    "msp": {
      "id": "67bc36db80a1616ec3f47088",
      "name": "Northline MSP"
    },
    "project": {
      "id": "67bc36db80a1616ec3f47011",
      "name": "Northern Rail Electrification"
    },
    "invoiceType": "mspToClient",
    "mspInvoiceType": "receivable",
    "reason": "Other",
    "comments": "Manual correction",
    "weekEnding": "2026-03-08T00:00:00.000Z",
    "confirmedDate": "2026-03-25T12:00:00.000Z",
    "confirmedBy": {
      "id": "67bc36db80a1616ec3f47099",
      "name": "Pat Taylor"
    },
    "payment": {
      "reference": "PAY-3001",
      "paymentDate": "2026-03-25T12:00:00.000Z"
    },
    "values": {
      "grossHours": 8.11,
      "netHours": 7.55,
      "subtotal": 694.45,
      "vat": 138.89,
      "total": 833.34,
      "cis": 0,
      "finalTotal": 833.34
    },
    "files": {
      "creditNote": "https://files.requidex.com/credit-notes/CN-12.pdf"
    },
    "invoice": {
      "id": "67bc36db80a1616ec3f4b001",
      "reference": "RDX-NLD-I1044"
    },
    "timesheet": {
      "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	Credit note not found
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Unexpected internal error