Search Disbursements

get

https://api.branchapp.com/v1/organizations/{orgId}/disbursements

Searches disbursements while returning HATEOAS links (e.g. prev_page, next_page) for retrieving additional data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

int32

required

Organization ID

Query Params

status

string

enum

CREATED: The disbursement was created and Branch is attempting to disburse funds

ATTEMPTING_PAYBACK: Branch successfully disbursed funds and is attempting pay back for the disbursement

PAYBACK_FAILED: Branch successfully disbursed funds but was unable to complete pay back for the disbursement

COMPLETED: Branch successfully disbursed funds

FAILED: Funds were unable to be disbursed

SKIPPED: Funds were not disbursed because an identical disbursement already existed

CANCELLED: Funds were not disbursed and no further action will be attempted for the disbursement

SCHEDULED: Funds are scheduled to disburse in the future

type

string

enum

TIPS: Disbursement for tips earned by worker

TRIP: Disbursement for trip made by worker

MILEAGE: Disbursement for miles driven by worker

PAYCHECK: Disbursement for income earned by worker

MISCELLANEOUS: Disbursement to worker for miscellaneous reasons

DEVICE: Disbursement for a worker’s device

DELIVERY: Disbursement for delivery made by worker

DEPOSIT: Disbursement for generic purposes

REWARD: Disbursement for a reward earned

PER_DIEM: Disbursement for per diem reimbursement

BONUS: Disbursement representing a non-usual payment

external_id

string

A unique ID with custom specification that correlates back to your own records.

invoice_id

int32

The ID of the invoice requesting payback for the disbursement

amount

int32

Amount of disbursement in cents

employee_id

string

The employee's ID

employee_group

string

A grouping for the employee. This could be anything that is used by your organization in order to group employees: store id, employee tier, region code, etc.

time_created_start

date-time

The start of the timeframe to search for created disbursement

time_created_end

date-time

The end of the timeframe to search for created disbursements

last_time_created

date-time

The latest time before which to search for attempted disbursements

last_id

int32

The largest ID lower than which to search for attempted disbursements

page

int64

Defaults to 1

Index of the requested page

size

int64

Defaults to 20

Number of elements in the requested page

sort

string

required

Format: field_name,direction

Response

200OK