Supplier Orders

Purchase orders sent to suppliers.

Endpoints

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

Parameters

page, per_page, date_start, date_end, status, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "120",
            "ref": "CF2405-0003",
            "supplier_ref": "SO-2024-789",
            "date_order": "2024-05-12",
            "date_delivery": "2024-06-01",
            "status": "ordered",
            "billed": false,
            "total_excl_tax": "3200.00",
            "total_vat": "640.00",
            "total_incl_tax": "3840.00"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "supplier_order": {
        "id": "120",
        "ref": "CF2405-0003",
        "supplier_ref": "SO-2024-789",
        "date_order": "2024-05-12",
        "date_order_supplier": "2024-05-14",
        "date_delivery": "2024-06-01",
        "validated_at": "2024-05-12T10:00:00Z",
        "approved_at": "2024-05-13T09:30:00Z",
        "created_at": "2024-05-12T09:00:00Z",
        "updated_at": "2024-05-14T11:00:00Z",
        "status": "ordered",
        "billed": false,
        "payment_terms": "Net 30 days",
        "payment_method": "Bank transfer",
        "bank_account": "Main account",
        "total_excl_tax": "3200.00",
        "total_vat": "640.00",
        "total_incl_tax": "3840.00",
        "multicurrency_code": "EUR",
        "multicurrency_total_excl_tax": "3200.00",
        "multicurrency_total_vat": "640.00",
        "multicurrency_total_incl_tax": "3840.00",
        "public_note": "",
        "lines": [
            {
                "id": "240",
                "position": 1,
                "product_ref": "COMP-A1",
                "product_label": "Component A1",
                "product_type": "product",
                "description": "Main circuit board",
                "quantity": "200.00",
                "unit": "piece",
                "unit_price_excl_tax": "16.00",
                "discount_percent": "0.00",
                "vat_rate": "20.000",
                "total_excl_tax": "3200.00",
                "total_vat": "640.00",
                "total_incl_tax": "3840.00",
                "multicurrency_code": "EUR",
                "multicurrency_unit_price": "16.00",
                "multicurrency_total_excl_tax": "3200.00",
                "multicurrency_total_vat": "640.00",
                "multicurrency_total_incl_tax": "3840.00"
            }
        ]
    }
}

Download PDF

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