GET All Credit Notes

Production

https://{{subdomain}}.daftra.com/api2

GET

/credit_notes{format}

Returns a paginated list of the account's credit notes, most recent first.

The list supports the same rich filtering as the invoices list (applied to credit-note documents) through the query parameters below. Each item is returned under a CreditNote member; see GET Single Credit Note for the full field reference.

Requires permission to view invoices/credit notes. A non-owner without all-invoices access sees only credit notes they created.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

A paginated list of credit notes.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/credit_notes.json?page=1&limit=20&client_id=&client_type=&no=&item=&currency_code=&payment_status=&tags=&source_type=&source_id=&work_order_id=&order_source_id=&custom_field=&custom_field_label=&staff_id=&sales_person_id=&summary_total_from=&summary_total_to=&date_from=&date_to=&created_from=&created_to=' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": [
        {
            "CreditNote": {}
        }
    ],
    "pagination": {
        "prev": "string",
        "next": "string",
        "page": 1,
        "page_count": 1,
        "total_results": 1
    }
}

Delete Estimates

GET Single Credit Note