Ramp.Reimbursements (ramp v1.0.0)

Copy Markdown View Source

The Reimbursements resource: read-only access to out-of-pocket employee expense reimbursements.

Summary

Types

list_opt()

Functions

get(client, id)

Fetches a single reimbursement by ID.

list(client, opts \\ [])

Returns a lazily auto-paginating Stream of Ramp.Reimbursements.Reimbursements.

list_page(client, opts \\ [])

Fetches a single page of reimbursements. See Ramp.Page.

Types

list_opt()

@type list_opt() ::
  {:start, String.t()}
  | {:page_size, pos_integer()}
  | {:user_id, String.t()}
  | {:status, String.t()}
  | {:from_date, DateTime.t()}
  | {:to_date, DateTime.t()}

Functions

get(client, id)

@spec get(Ramp.Client.t(), String.t()) ::
  {:ok, Ramp.Reimbursements.Reimbursement.t()} | {:error, Ramp.Error.t()}

Fetches a single reimbursement by ID.

list(client, opts \\ [])

@spec list(Ramp.Client.t(), [list_opt()]) ::
  Enumerable.t(Ramp.Reimbursements.Reimbursement.t())

Returns a lazily auto-paginating Stream of Ramp.Reimbursements.Reimbursements.

list_page(client, opts \\ [])

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.Reimbursements.Reimbursement.t())}
  | {:error, Ramp.Error.t()}

Fetches a single page of reimbursements. See Ramp.Page.