OBAPI OBAPI

Supplier Proposals

Request for quotation / price request sent to a supplier.

Endpoints

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

Parameters

page, per_page, date_start, date_end, status, sort

Status values

draft, validated, signed, refused, closed

Response (list)

{
    "items": [
        {
            "id": "80",
            "ref": "PF2405-0001",
            "supplier_ref": "Q-2024-112",
            "date_proposal": "2024-05-10",
            "status": "validated",
            "total_excl_tax": "2500.00",
            "total_vat": "500.00",
            "total_incl_tax": "3000.00"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "supplier_proposal": {
        "id": "80",
        "ref": "PF2405-0001",
        "supplier_ref": "Q-2024-112",
        "date_proposal": "2024-05-10",
        "date_delivery": "2024-06-15",
        "validated_at": "2024-05-11T09:00:00Z",
        "created_at": "2024-05-10T14:00:00Z",
        "updated_at": "2024-05-11T09:00:00Z",
        "status": "validated",
        "payment_terms": "Net 30 days",
        "payment_method": "Bank transfer",
        "total_excl_tax": "2500.00",
        "total_vat": "500.00",
        "total_incl_tax": "3000.00",
        "multicurrency_code": "EUR",
        "multicurrency_total_excl_tax": "2500.00",
        "multicurrency_total_vat": "500.00",
        "multicurrency_total_incl_tax": "3000.00",
        "public_note": "",
        "lines": [
            {
                "id": "160",
                "position": 1,
                "product_ref": "COMP-A1",
                "product_label": "Component A1",
                "product_type": "product",
                "description": "Main circuit board",
                "quantity": "100.00",
                "unit": "piece",
                "unit_price_excl_tax": "25.00",
                "discount_percent": "0.00",
                "vat_rate": "20.000",
                "total_excl_tax": "2500.00",
                "total_vat": "500.00",
                "total_incl_tax": "3000.00",
                "multicurrency_code": "EUR",
                "multicurrency_unit_price": "25.00",
                "multicurrency_total_excl_tax": "2500.00",
                "multicurrency_total_vat": "500.00",
                "multicurrency_total_incl_tax": "3000.00"
            }
        ]
    }
}

Download PDF

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