WAwafeq
Expense Reports

Retrieve expense report

Changed on

Endpoint for retrieving a single expense report.

get/expense-reports/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/expense-reports/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: claims, claims.account, claims.attachments, claims.branch, claims.contact, claims.cost_center, claims.project, claims.tax_rate, employee, employee.reimbursements_account, journal, reimbursements_account, reimbursements_account.parent. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Response

amountnumber double nullable required

The total of all claims in the report, converted to the organization base currency.

approved_tsstring date-time nullable required

The timestamp in UTC when the report was approved, or null if it was not.

created_tsstring date-time required

The timestamp in UTC when the expense report was created

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

An ISO 4217 currency code.

View the enum reference

descriptionstring required

Notes the employee added to the report.

employeestring nullable required

The employee the report belongs to, or null when no employee is linked.

exchange_ratenumber double nullable required

The exchange rate from the report currency to the organization base currency at the time of the report.

idstring required

The unique identifier of the expense report.

modified_tsstring date-time required

The timestamp in UTC when the expense report was last modified

referencestring required

An optional reference code or number for this report.

reimbursements_accountstring nullable required

The employee reimbursements liability account the report journal credits, if set.

rejected_tsstring date-time nullable required

The timestamp in UTC when the report was last rejected, or null if it was not.

report_datestring date nullable required

The date of the report, used as the date of its journal entry, or null while it is not set.

report_numberstring required

The number assigned to the report.

status'DRAFT' | 'PENDING_APPROVAL' | 'APPROVED' | 'REJECTED' | 'REIMBURSING' | 'REIMBURSED' required

The current lifecycle status of an expense report.

View the enum reference

submitted_tsstring date-time nullable required

The timestamp in UTC when the report was last submitted for approval, or null if it was not.

titlestring required

The title the employee gave the report.

Changes