Supplier Invoices

Invoices received from suppliers.

Endpoints

• GET /obapi/v1/supplier-invoices -- list
• GET /obapi/v1/supplier-invoices/{id} -- single with lines
• GET /obapi/v1/download/{id}?type=supplier-invoice -- PDF

Parameters

page, per_page, date_start, date_end, status, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "450",
            "ref": "FI2405-0012",
            "supplier_ref": "INV-2024-5678",
            "label": "May 2024 services",
            "date_invoice": "2024-05-20",
            "date_due": "2024-06-20",
            "status": "validated",
            "paid": false,
            "total_excl_tax": "4200.00",
            "total_vat": "840.00",
            "total_incl_tax": "5040.00"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "supplier_invoice": {
        "id": "450",
        "ref": "FI2405-0012",
        "supplier_ref": "INV-2024-5678",
        "label": "May 2024 services",
        "type": "standard",
        "date_invoice": "2024-05-20",
        "date_due": "2024-06-20",
        "validated_at": "2024-05-21T09:00:00Z",
        "created_at": "2024-05-20T14:30:00Z",
        "updated_at": "2024-05-21T09:00:00Z",
        "status": "validated",
        "paid": false,
        "payment_terms": "Net 30 days",
        "payment_method": "Bank transfer",
        "bank_account": "Main account",
        "total_excl_tax": "4200.00",
        "total_vat": "840.00",
        "total_incl_tax": "5040.00",
        "multicurrency_code": "EUR",
        "close_code": "",
        "close_note": "",
        "public_note": "",
        "lines": [
            {
                "id": "890",
                "position": 1,
                "product_ref": "HOSTING-PRO",
                "product_label": "Professional hosting",
                "product_type": "service",
                "description": "Hosting May 2024",
                "quantity": "1.00",
                "unit": "month",
                "unit_price_excl_tax": "4200.00",
                "discount_percent": "0.00",
                "vat_rate": "20.000",
                "total_excl_tax": "4200.00",
                "total_vat": "840.00",
                "total_incl_tax": "5040.00"
            }
        ]
    }
}

Invoice types

Download PDF

GET /obapi/v1/download/{id}?type=supplier-invoice