Credit Notes

Credit note / avoir. Same structure as Invoice with type always set to credit_note.

List credit notes

• Method: GET /obapi/v1/creditnotes
• Headers: Authorization: Bearer {apikey}

Parameters: same as Invoices (page, per_page, date_start, date_end, status, sort).

Get a single credit note

• Method: GET /obapi/v1/creditnotes/{id}

Status values

Same as Invoices: draft, validated, paid, abandoned.

Response (single)

{
    "creditnote": {
        "id": "3050",
        "ref": "AV2405-0001",
        "customer_ref": "",
        "type": "credit_note",
        "related_invoice_ref": "FA2405-2401",
        "date_invoice": "2024-05-28",
        "date_due": "2024-05-28",
        "status": "validated",
        "total_excl_tax": "1.00",
        "total_vat": "0.20",
        "total_incl_tax": "1.20",
        "public_note": "Refund for invoice FA2405-2401",
        "lines": [
            {
                "id": "5500",
                "position": 1,
                "product_ref": "BUYMEACOFFEE",
                "product_label": "Buy me a coffee",
                "product_type": "service",
                "description": "Refund",
                "quantity": "1.00",
                "unit_price_excl_tax": "1.00",
                "vat_rate": "20.000",
                "total_excl_tax": "1.00",
                "total_vat": "0.20",
                "total_incl_tax": "1.20"
            }
        ]
    }
}

Notes

All amounts are positive -- the sign is implied by the document type (credit note = negative in accounting).

Download PDF

GET /obapi/v1/download/{id}?type=creditnote