Get Credit note

Returns a single credit note by ID.

GEThttps://api.tracksales.co/api/v1/credit-notes/{uuid}

Required scope: credit_notes:read

Path Params

uuidstringrequired

Credit note UUID

Responses

200OK

Request succeeded.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Credit note was not found.

422Validation Error

Request validation failed.

curl -X GET 'https://api.tracksales.co/api/v1/credit-notes/{uuid}' \
  -H 'Authorization: Bearer ts_live_YOUR_API_KEY' \
  -H 'Accept: application/json'

{
    "success": true,
    "data": {
        "credit_note_id": 401,
        "customerId": 42,
        "total": 2000,
        "status": "open"
    }
}

{
    "success": false,
    "error": {
        "code": "unauthenticated",
        "message": "Invalid or revoked API key."
    }
}

{
    "success": false,
    "error": {
        "code": "forbidden",
        "message": "API key lacks required scope."
    }
}

{
    "success": false,
    "message": "Credit note not found"
}

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "field": [
            "The field is required."
        ]
    }
}