Expense Items

Create an expense item

post/expense-items

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/expense-items
  • Auth: HTTP bearer

Request body

vendorNamestring nullable

The name of the vendor for the expense. Max 255 characters.

notesstring nullable

Notes about the expense item. Max 5000 characters.

attendeesstring nullable

Attendees for the expense. Max 5000 characters.

datestring date required

The date of the expense. Should be in the form YYYY-MM-DD.

currencystring

The ISO 4217 currency code for the expense amount (e.g. USD). Defaults to the workspace currency if not provided.

expenseAmountnumber required

The expense amount in the expense's currency.

markupMethod'percentage' | 'amount' | 'null' nullable

The markup method to apply to the expense.

markupRationumber nullable

The markup ratio (e.g. 0.1 for 10%). Must be between 0 and 1. Used when markupMethod is percentage.

markupAmountnumber nullable

The fixed markup amount. Used when markupMethod is amount.

unitCountnumber nullable

The number of units for unit-based expense categories.

unitAmountnumber nullable

The per-unit amount for unit-based expense categories.

isReimbursableboolean required

Whether the expense is reimbursable to the member.

isBillableboolean required

Whether the expense item is billable back to the client.

isReimbursedboolean

When set to true, marks the expense as reimbursed to the member. The expense item must be reimbursable.

expenseReportIdstring required

The expense report ID (uuid) this item belongs to.

expenseCategoryIdstring required

The expense category ID (uuid) for this item.

memberIdstring required

The member ID (uuid) of the member who incurred the expense.

projectIdstring nullable

The project ID (uuid) to associate this expense with.

Response

200

idstring

The unique identifier for the object.

statusId'not_submitted' | 'pending_approval' | 'approved' | 'rejected'

The approval status of the expense item.

vendorstring nullable

The name of the vendor for the expense.

notesstring nullable

Additional notes about the expense item.

attendeesstring nullable

The attendees for the expense (e.g. for meals or entertainment categories).

datestring date

The date of the expense. In the form YYYY-MM-DD.

currencystring

The ISO 4217 currency code for the expense amount (e.g. USD).

amountnumber

The expense amount in the expense's currency.

markupMethod'percentage' | 'amount' | 'null' nullable

The markup method applied to the expense. null if no markup is applied.

markupRationumber nullable

The markup ratio (e.g. 0.1 for 10%). Present when markupMethod is percentage, otherwise null.

markupAmountnumber nullable

The fixed markup amount. Present when markupMethod is amount, otherwise null.

markupnumber nullable

The computed markup value in the expense's currency. null when no markup method is set.

totalnumber

The total billed amount including any markup, in the expense's currency.

unitCountnumber nullable

The number of units for unit-based expense categories. null if not applicable.

unitAmountnumber nullable

The per-unit amount for unit-based expense categories. null if not applicable.

isReimbursableboolean

Whether the expense is reimbursable to the member.

isBillableboolean

Whether the expense item is billable back to the client.

isReimbursedboolean

Whether the expense has been reimbursed to the member.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

invoicedboolean

Whether this record has been invoiced.

Changes

No recorded changes to this operation across all 1 revision of this API.