List Credit notes

Returns Credit notes for the organization.

GEThttps://api.tracksales.co/api/v1/credit-notes

Required scope: credit_notes:read

Query Params

searchstring

Search by name, code, or reference

location_idinteger

Filter by branch/location ID

customer_idinteger

Filter by customer ID

statusstring

Filter by status: open, closed, or draft

limitinteger

Page size (default 20, max 100)

offsetinteger

Pagination offset (default 0)

Responses

200OK

Request succeeded.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Credit-notes was not found.

422Validation Error

Request validation failed.

curl -X GET 'https://api.tracksales.co/api/v1/credit-notes?limit=20&search=acme' \
  -H 'Authorization: Bearer ts_live_YOUR_API_KEY' \
  -H 'Accept: application/json'

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

{
    "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-notes not found"
}

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