Expense Reports

Employee expense claims.

Endpoints

• GET /obapi/v1/expense-reports -- list
• GET /obapi/v1/expense-reports/{id} -- single with lines
• GET /obapi/v1/download/{id}?type=expense-report -- PDF

Parameters

page, per_page, date_start, date_end, status, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "75",
            "ref": "NDF2405-0008",
            "date_start": "2024-05-01",
            "date_end": "2024-05-31",
            "status": "approved",
            "paid": false,
            "total_excl_tax": "342.50",
            "total_incl_tax": "411.00"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "expense_report": {
        "id": "75",
        "ref": "NDF2405-0008",
        "date_start": "2024-05-01",
        "date_end": "2024-05-31",
        "created_at": "2024-06-01T09:00:00Z",
        "updated_at": "2024-06-03T14:00:00Z",
        "validated_at": "2024-06-01T09:00:00Z",
        "approved_at": "2024-06-03T14:00:00Z",
        "status": "approved",
        "paid": false,
        "payment_method": "Bank transfer",
        "total_excl_tax": "342.50",
        "total_vat": "68.50",
        "total_incl_tax": "411.00",
        "multicurrency_code": "EUR",
        "refuse_reason": "",
        "cancel_reason": "",
        "public_note": "",
        "lines": [
            {
                "id": "150",
                "position": 1,
                "fee_type": "Train ticket",
                "date": "2024-05-12",
                "comments": "Paris - Lyon round trip",
                "quantity": "1.00",
                "unit_value": "125.00",
                "vat_rate": "10.000",
                "total_excl_tax": "113.64",
                "total_vat": "11.36",
                "total_incl_tax": "125.00",
                "project_ref": "PJ2405-0003"
            },
            {
                "id": "151",
                "position": 2,
                "fee_type": "Hotel",
                "date": "2024-05-12",
                "comments": "1 night in Lyon",
                "quantity": "1.00",
                "unit_value": "156.00",
                "vat_rate": "20.000",
                "total_excl_tax": "130.00",
                "total_vat": "26.00",
                "total_incl_tax": "156.00",
                "project_ref": "PJ2405-0003"
            },
            {
                "id": "152",
                "position": 3,
                "fee_type": "Meals",
                "date": "2024-05-12",
                "comments": "Dinner with client",
                "quantity": "1.00",
                "unit_value": "130.00",
                "vat_rate": "20.000",
                "total_excl_tax": "98.86",
                "total_vat": "31.14",
                "total_incl_tax": "130.00",
                "project_ref": ""
            }
        ]
    }
}

Download PDF

GET /obapi/v1/download/{id}?type=expense-report