Skip to main content
API docs by Redocly

Branch API (2.0.5)

Download OpenAPI specification:Download

Branch API

Wallet

Create Wallet

Creates a digital wallet for an employee. Optionally allows a Branch card to be automatically ordered for the employee.

path Parameters
orgId
required
integer <int32>

The Organization ID

employeeId
required
string

The Employee ID

header Parameters
apikey
required
string
X-Test-Mode
boolean
Request Body schema: application/json
first_name
required
string

Numbers not allowed

middle_name
string

Numbers not allowed

last_name
required
string

Numbers not allowed

required
object (Address)
date_of_birth
required
string[0-9]{4}-[0-9]{2}-[0-9]{2}

Birthdate provided must indicate greater than 14 years of age. Some organizations may not allow accounts if the age is not 18 or greater.

ssn
required
string[0-9]{9}
phone_number
required
string
email_address
required
string
type
string
Enum: "HOURLY" "SALARY"
pay_rate
integer <int32> >= 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

group_name
string
create_employee
boolean
Default: false

If true and the employee does not already exist, will create the employee with the given information.

order_card
boolean
Default: false

If true, a physical card will be shipped to the user when the account is created.

card_program
string

Specifies which card should be ordered and delivered to the user. Available options for an organization can be found by querying the card-controller -> getCardPrograms endpoint.Default is organization's default card program - generally BRANCH_W2

ein
string

9 digit employer identification number

business_name
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "middle_name": "William",
  • "last_name": "Larson",
  • "address": {
    },
  • "date_of_birth": "2000-01-01",
  • "ssn": "123456789",
  • "phone_number": "+11235550123",
  • "email_address": "worker@branchapp.com",
  • "type": "HOURLY",
  • "pay_rate": 1500,
  • "group_name": "GOLD",
  • "create_employee": false,
  • "order_card": false,
  • "card_program": "BRANCH_W2",
  • "ein": "XXXXXXXXX",
  • "business_name": "Dunder Mifflin Paper Company"
}

Response samples

Content type
application/json
{
  • "employee_id": "string",
  • "account_number": "000000000000",
  • "routing_number": "123456789",
  • "has_activated_card": true,
  • "status": "ACTIVE",
  • "reason_code": "ADDITIONAL_DOCS_REQ",
  • "reason": "string",
  • "onboarding_link": "string",
  • "kyc_additional_documentation_link": "string",
  • "ein": "string",
  • "business_name": "string",
  • "time_last_initialization_attempted": "2019-08-24T14:15:22Z",
  • "time_created": "2019-08-24T14:15:22Z"
}

Get Wallets

Get a list of wallets for an organization.

path Parameters
orgId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Wallet Status

Get the status of wallets for an organization.

path Parameters
orgId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Employee Wallet

Get wallet for an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

V2 Disbursements

Search Disbursements

Searches all disbursements sent to worker.

path Parameters
orgId
required
integer <int32>
workerId
required
string
query Parameters
id
integer <int64>
status
string
Enum: "PENDING" "SCHEDULED" "COMPLETED" "FAILED" "CANCELED" "SKIPPED" "UNKNOWN"
type
string
Enum: "TIP" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"
external_id
string
invoice_id
integer <int64>
worker_id
string
time_last_attempted_start
string <date-time>
time_last_attempted_end
string <date-time>
after
string
before
string
size
integer <int64>
sort
string
Example: sort=id,asc

Format: field_name,direction

header Parameters
apikey
required
string

Responses

Create Disbursement

Creates a disbursement for an worker. A disbursement is an initiation of payment to a worker.

path Parameters
orgId
required
integer <int32>
workerId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
amount
required
integer <int32> >= 0

Amount, in cents, to be disbursed to the worker.

external_id
required
string [ 0 .. 64 ] characters

Allows the custom specification of a unique ID that correlates back to your own records.

type
required
string
Enum: "TIP" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"

TIP: Disbursement for a tip earned by worker
TRIP: Disbursement for a 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 a delivery made by worker
DEPOSIT: Disbursement for a generic purposes
REWARD: Disbursement for a reward earned
BONUS: Disbursement representing a non-usual payment

worker_group
string [ 0 .. 150 ] characters

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

display_header_label
string [ 0 .. 32 ] characters

A description of the disbursement. This will be displayed to the worker

display_sub_label
string [ 0 .. 32 ] characters

A description of the disbursement. This will be displayed to the worker in the application

description
required
string [ 0 .. 256 ] characters
retry
boolean

Default false. If status goes into FAILED, allows disbursement to be reattempted.

object
time_scheduled
string <date-time>

Date and time at which the specified amount will be disbursed to the worker.

Responses

Request samples

Content type
application/json
{
  • "amount": 500,
  • "external_id": "123456",
  • "type": "MILEAGE",
  • "worker_group": "Store #1",
  • "display_header_label": "Tip for delivery",
  • "display_sub_label": "Tip for delivery",
  • "description": "Disbursement for miles driven.",
  • "retry": true,
  • "metadata": {
    },
  • "time_scheduled": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "worker_id": "123",
  • "amount": 500,
  • "external_id": "123456",
  • "type": "TIP",
  • "worker_group": "Store #1",
  • "description": "Disbursement for miles driven",
  • "display_header_label": "Tip for delivery",
  • "display_sub_label": "Tip for delivery",
  • "status": "COMPLETED",
  • "reason_code": "WORKER_NOT_FOUND",
  • "payout": {
    },
  • "metadata": {
    },
  • "time_created": "2019-08-24T14:15:22Z",
  • "time_modified": "2019-08-24T14:15:22Z"
}

Search Disbursements

Searches all disbursements.

path Parameters
orgId
required
integer <int32>
query Parameters
id
integer <int64>
status
string
Enum: "PENDING" "SCHEDULED" "COMPLETED" "FAILED" "CANCELED" "SKIPPED" "UNKNOWN"
type
string
Enum: "TIP" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"
external_id
string
invoice_id
integer <int64>
worker_id
string
time_last_attempted_start
string <date-time>
time_last_attempted_end
string <date-time>
after
string
before
string
size
integer <int64>
sort
string
Example: sort=id,asc

Format: field_name,direction

header Parameters
apikey
required
string

Responses

Wallet Payout Details

Get Wallet Payout

Returns Wallet payout details for a disbursement

path Parameters
orgId
required
integer <int32>
transferId
required
string
header Parameters
apikey
required
string

Responses

Card Payout Details

Get External Card Payout

Returns external card payout details for a disbursement

path Parameters
orgId
required
integer <int32>
transferId
required
string
header Parameters
apikey
required
string

Responses

External Cards

Get External Cards for Employee

Get a list of external cards for an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
query Parameters
network
string
Example: network=visa
last4
string
Example: last4=1234
time_created_start
string <date-time>
Example: time_created_start=2023-01-01T00:00:00.000Z
time_created_end
string <date-time>
Example: time_created_end=2023-01-31T23:59:59.999Z
sort
string
direction
string
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Add External Card for Employee

Add an external card for an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
token
required
string
required
object (Owner)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "owner": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "network": "string",
  • "last_four": "string",
  • "time_created": "2019-08-24T14:15:22Z"
}

Get External Cards for Entity

Get a list of external cards for an entity.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
entityId
required
integer <int64>
header Parameters
apikey
required
string

Responses

Delete External Card for Entity

Delete an external card for an entity.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
entityId
required
integer <int64>
header Parameters
apikey
required
string

Responses

Payment Profile

Get Payment Profile

Get the payment profile for an employee, which shows the payment types by which a worker can be paid according to their current configuration, and the active payment type.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Response samples

Content type
application/json
{
  • "additional_payment_methods": [
    ],
  • "payment_method": {
    }
}

Update Payment Profile

Update a worker's payment profile to change the active payment type.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
type
string
Enum: "WALLET" "CARD" "NONE"
ref
string

Responses

Request samples

Content type
application/json
{
  • "type": "WALLET",
  • "ref": "string"
}

Response samples

Content type
application/json
{
  • "additional_payment_methods": [
    ],
  • "payment_method": {
    }
}

Cards

Get Active User Card

Card returned will be either active or temporarily suspended. Permanently terminated cards are not returned.
If the provided user does not have an active or suspended card, call will return 404 - Not Found.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Response samples

Content type
application/json
{
  • "state": "ACTIVE",
  • "card_type": "PHYSICAL",
  • "time_created": "2020-02-18T19:42:48Z"
}

Disbursement Fee

Calculate a disbursement fee

Uses the current organization fee settings to calculate the fees that will be charged for a given disbursement amount.

path Parameters
orgId
required
integer <int32>
header Parameters
apikey
required
string
Request Body schema: application/json
amount
integer <int32> >= 1
payment_method_type
required
string
Enum: "CARD" "WALLET"

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "payment_method_type": "CARD"
}

Response samples

Content type
application/json
Example

Valid Amount Disbursed

{
  • "disbursement": 10000,
  • "sent_to_worker": 9900,
  • "user_paid_fee": 100,
  • "error_reason_code": null
}

Get Disbursement Fees for Organization

path Parameters
orgId
required
integer <int32>
header Parameters
apikey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Wallet

Create Wallet

Creates a digital wallet for an employee. Optionally allows a Branch card to be automatically ordered for the employee.

path Parameters
orgId
required
integer <int32>

The Organization ID

employeeId
required
string

The Employee ID

header Parameters
apikey
required
string
X-Test-Mode
boolean
Request Body schema: application/json
first_name
required
string

Numbers not allowed

middle_name
string

Numbers not allowed

last_name
required
string

Numbers not allowed

required
object (Address)
date_of_birth
required
string[0-9]{4}-[0-9]{2}-[0-9]{2}

Birthdate provided must indicate greater than 14 years of age. Some organizations may not allow accounts if the age is not 18 or greater.

ssn
required
string[0-9]{9}
phone_number
required
string
email_address
required
string
type
string
Enum: "HOURLY" "SALARY"
pay_rate
integer <int32> >= 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

group_name
string
create_employee
boolean
Default: false

If true and the employee does not already exist, will create the employee with the given information.

order_card
boolean
Default: false

If true, a physical card will be shipped to the user when the account is created.

card_program
string

Specifies which card should be ordered and delivered to the user. Available options for an organization can be found by querying the card-controller -> getCardPrograms endpoint.Default is organization's default card program - generally BRANCH_W2

ein
string

9 digit employer identification number

business_name
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "middle_name": "William",
  • "last_name": "Larson",
  • "address": {
    },
  • "date_of_birth": "2000-01-01",
  • "ssn": "123456789",
  • "phone_number": "+11235550123",
  • "email_address": "worker@branchapp.com",
  • "type": "HOURLY",
  • "pay_rate": 1500,
  • "group_name": "GOLD",
  • "create_employee": false,
  • "order_card": false,
  • "card_program": "BRANCH_W2",
  • "ein": "XXXXXXXXX",
  • "business_name": "Dunder Mifflin Paper Company"
}

Response samples

Content type
application/json
{
  • "employee_id": "string",
  • "account_number": "000000000000",
  • "routing_number": "123456789",
  • "has_activated_card": true,
  • "status": "ACTIVE",
  • "reason_code": "ADDITIONAL_DOCS_REQ",
  • "reason": "string",
  • "onboarding_link": "string",
  • "kyc_additional_documentation_link": "string",
  • "ein": "string",
  • "business_name": "string",
  • "time_last_initialization_attempted": "2019-08-24T14:15:22Z",
  • "time_created": "2019-08-24T14:15:22Z"
}

Get Wallets

Get a list of wallets for an organization.

path Parameters
orgId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Wallet Status

Get the status of wallets for an organization.

path Parameters
orgId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Employee Wallet

Get wallet for an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Disbursements

Get Employee Disbursements

Get a list of disbursements for an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
query Parameters
id
integer <int32>
status
string
Enum: "CREATED" "ATTEMPTING_PAYBACK" "PAYBACK_FAILED" "COMPLETED" "FAILED" "SKIPPED" "CANCELLED" "SCHEDULED" "UNKNOWN"
type
string
Enum: "TIPS" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"
external_id
string
invoice_id
integer <int32>
amount
integer <int32>
employee_id
string
employee_group
string
time_created_start
string <date-time>
time_created_end
string <date-time>
page_direction
string
Enum: "PREV" "NEXT"
last_time_created
string <date-time>
last_id
integer <int32>
page
integer <int64>
size
integer <int64>
sort
required
string

Format: field_name,direction

header Parameters
apikey
required
string

Responses

Create Disbursement

Creates a disbursement for an employee. This initiates a payment to the employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
amount
required
integer <int32> >= 0

Amount, in cents, to be disbursed to the employee.

external_id
required
string [ 0 .. 64 ] characters

Allows the custom specification of a unique ID that correlates back to your own records.

type
required
string
Enum: "TIPS" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"

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
BONUS: Disbursement representing a non-usual payment

employee_group
string [ 0 .. 150 ] characters

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.

display_sub_label
string [ 0 .. 150 ] characters

A description of the disbursement. This will be displayed to the worker in the application

description
required
string [ 0 .. 256 ] characters
retry
boolean

Default false. If status goes into FAILED, allows disbursement to be reattempted.

object
time_scheduled
string <date-time>

Date and time at which the specified amount will be disbursed to the employee.

Responses

Request samples

Content type
application/json
{
  • "amount": 500,
  • "external_id": "123456",
  • "type": "MILEAGE",
  • "employee_group": "Store #1",
  • "display_sub_label": "Tip for delivery",
  • "description": "Disbursement for miles driven.",
  • "retry": true,
  • "metadata": {
    },
  • "time_scheduled": "2019-08-24T14:15:22Z"
}

Get Invoice Disbursements

Get a list of disbursements for an invoice.

path Parameters
orgId
required
integer <int32>
invoiceId
required
integer <int32>
query Parameters
id
integer <int32>
status
string
Enum: "CREATED" "ATTEMPTING_PAYBACK" "PAYBACK_FAILED" "COMPLETED" "FAILED" "SKIPPED" "CANCELLED" "SCHEDULED" "UNKNOWN"
type
string
Enum: "TIPS" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"
external_id
string
invoice_id
integer <int32>
amount
integer <int32>
employee_id
string
employee_group
string
time_created_start
string <date-time>
time_created_end
string <date-time>
page_direction
string
Enum: "PREV" "NEXT"
last_time_created
string <date-time>
last_id
integer <int32>
page
integer <int64>
size
integer <int64>
sort
required
string

Format: field_name,direction

header Parameters
apikey
required
string

Responses

Search Disbursements

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

path Parameters
orgId
required
integer <int32>
query Parameters
id
integer <int32>
status
string
Enum: "CREATED" "ATTEMPTING_PAYBACK" "PAYBACK_FAILED" "COMPLETED" "FAILED" "SKIPPED" "CANCELLED" "SCHEDULED" "UNKNOWN"
type
string
Enum: "TIPS" "TRIP" "MILEAGE" "PAYCHECK" "MISCELLANEOUS" "DEVICE" "DELIVERY" "DEPOSIT" "BONUS" "REWARD" "UNKNOWN"
external_id
string
invoice_id
integer <int32>
amount
integer <int32>
employee_id
string
employee_group
string
time_created_start
string <date-time>
time_created_end
string <date-time>
page_direction
string
Enum: "PREV" "NEXT"
last_time_created
string <date-time>
last_id
integer <int32>
page
integer <int64>
size
integer <int64>
required
object (Sort)

Format: field_name,direction

header Parameters
apikey
required
string

Responses

Cards

Get Active User Card

Card returned will be either active or temporarily suspended. Permanently terminated cards are not returned.
If the provided user does not have an active or suspended card, call will return 404 - Not Found.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Response samples

Content type
application/json
{
  • "state": "ACTIVE",
  • "card_type": "PHYSICAL",
  • "time_created": "2020-02-18T19:42:48Z"
}

Employees

Get Employee

Get an Employee by ID.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Update Employee

Update an employee by ID.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
first_name
required
string

Numbers not allowed

last_name
required
string

Numbers not allowed

phone_number
string
email_address
string
type
string
Enum: "HOURLY" "SALARY"
pay_rate
integer <int32> >= 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

business_name
string
group_name
string
ein
string
password
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Larson",
  • "phone_number": "+11235550123",
  • "email_address": "worker@branchapp.com",
  • "type": "HOURLY",
  • "pay_rate": 0,
  • "business_name": "Dunder Mifflin Paper Company",
  • "group_name": "GOLD",
  • "ein": "XXXXXXXXX",
  • "password": "string"
}

Create Employee

Create a new employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
first_name
required
string

Numbers not allowed

last_name
required
string

Numbers not allowed

phone_number
string
email_address
string
type
string
Enum: "HOURLY" "SALARY"
pay_rate
integer <int32> >= 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

business_name
string
group_name
string
ein
string
password
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Larson",
  • "phone_number": "+11235550123",
  • "email_address": "worker@branchapp.com",
  • "type": "HOURLY",
  • "pay_rate": 0,
  • "business_name": "Dunder Mifflin Paper Company",
  • "group_name": "GOLD",
  • "ein": "XXXXXXXXX",
  • "password": "string"
}

Delete Employee

Delete an employee by ID.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Search Employees

Search for employees by providing search criteria.

path Parameters
orgId
required
integer <int32>
query Parameters
first_name
string
last_name
string
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Employee Address

Get the address of an employee.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string

Responses

Payroll Periods

Get Payroll Period

Get an existing payroll period.

path Parameters
orgId
required
integer <int32>
payrollPeriodId
required
integer <int32>
header Parameters
apikey
required
string

Responses

Update Payroll Period

Update a payroll period pay date and deadline.

path Parameters
orgId
required
integer <int32>
payrollPeriodId
required
integer <int32>
header Parameters
apikey
required
string
Request Body schema: application/json
payroll_deadline
string <date>

The date by which workers' pay must be determined.

pay_date
string <date>

The date individuals will receive payment.

Responses

Request samples

Content type
application/json
{
  • "payroll_deadline": "2000-01-01",
  • "pay_date": "2000-01-01"
}

Payroll Calendar

Get Payroll Calendar

Get the payroll calendar for an organization

path Parameters
orgId
required
integer <int32>
header Parameters
apikey
required
string

Responses

Create Payroll Calendar

Create a new payroll calendar, which defines payroll periods.

path Parameters
orgId
required
integer <int32>
header Parameters
apikey
required
string
Request Body schema: application/json
Array of objects (PayrollPeriodCreationRequest)

The list of payroll periods creation requests for the calendar.

Array
payroll_deadline
string <date>

The date by which workers' pay must be determined.

pay_date
string <date>

The date individuals will receive payment.

Responses

Request samples

Content type
application/json
{
  • "payroll_periods": [
    ]
}

Shifts

Get Shift

Get a worker's completed shift. Requires shift_id to identify which shift to retrieve. If an existing shift cannot be found with the provided shift_id, call will return 404 - Not Found. Successful call will return the completed shift.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
shiftId
required
string
header Parameters
apikey
required
string

Responses

Update Shift

Update a worker's completed shift. Requires shift_id to identify which shift to update. If an existing shift cannot be found with the provided shift_id, call will return 404 - Not Found. Requests made with missing required fields or invalid dates/times will return 400 - Bad Request. Successful call will return newly updated shift.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
shiftId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
punch_in
string <date-time>

Time the shift started

punch_out
string <date-time>

Time the shift ended. This does not need to be provided if 'hours' is provided

hours
number <double>

Number of hours worked in the shift. This does not need to be provided if 'punch_out' is provided

rate
integer <int32>

Amount of money, in cents, the employee made per hour/day depending on 'shift_type'

shift_type
string
Enum: "Daily" "Hourly"

Shift type, 'HOURLY' or 'DAILY'

Responses

Request samples

Content type
application/json
{
  • "punch_in": "2019-08-24T14:15:22Z",
  • "punch_out": "2019-08-24T14:15:22Z",
  • "hours": 0,
  • "rate": 0,
  • "shift_type": "Daily"
}

Delete shift

Delete an existing shift. Requires shift_id to identify which shift to delete. If an existing shift cannot be found with the provided shift_id, call will return 404 - Not Found. Successful call will return status 204 - No Content.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
shiftId
required
string
header Parameters
apikey
required
string

Responses

Submit Shift

Submit a person's completed shift. Shifts are used to track hours worked by an individual employee and calculate EWA. Shifts may be created with a shift_id unique within the organization. Failure to provide a shift_id will cause a UUID to be generated instead.If a duplicate shift_id is provided, call will return 409 - Conflict. Successful call will return the created shift and status 201.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
id
string

If blank, defaults to UUID

punch_in
string <date-time>

Time the shift started

punch_out
string <date-time>

Time the shift ended. This does not need to be provided if 'hours' is provided

hours
number <double> >= 0

Number of hours worked in the shift. This value cannot be negative. This does not need to be provided if 'punch_out' is provided

rate
integer <int32>

Amount of money, in cents, the employee made per hour/day depending on 'shift_type'

shift_type
required
string
Enum: "Daily" "Hourly"

Shift type, 'HOURLY' or 'DAILY'

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "punch_in": "2019-08-24T14:15:22Z",
  • "punch_out": "2019-08-24T14:15:22Z",
  • "hours": 0,
  • "rate": 0,
  • "shift_type": "Daily"
}

Employee Earnings

Update Employee Earning

Update an employee's earning for a period.

path Parameters
orgId
required
integer <int32>
employeeId
required
string
header Parameters
apikey
required
string
Request Body schema: application/json
amount
integer <int32> >= 1

earnings in cents. must be greater than 0

date
string <date> yyyy-MM-dd

Responses

Request samples

Content type
application/json
{
  • "amount": 1,
  • "date": "2021-06-24"
}

Remittance

Report Remittance Deduction

Post an amount that was deducted from a worker on the remittance.

path Parameters
orgId
required
integer <int32>
remittanceId
required
integer <int32>
header Parameters
apikey
required
string
Request Body schema: application/json
employee_id
required
string
amount
integer <int32> >= 0

Amount, in cents, that was successfully deducted for the employee

Responses

Request samples

Content type
application/json
{
  • "employee_id": "string",
  • "amount": 0
}

Complete Remittance Deduction

Update an existing remittance to mark it as completed.

path Parameters
orgId
required
integer <int32>
remittanceId
required
integer <int32>
header Parameters
apikey
required
string
Request Body schema: application/json
status
required
stringCOMPLETED

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Get Remittances

Return a list of remittances by an organization.

path Parameters
orgId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Get Remittance Requested Deductions

Return a list of requested deductions from an organization's remittance.

path Parameters
orgId
required
integer <int32>
remittanceId
required
integer <int32>
query Parameters
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses

Advances

Search Advances

Search for advances by an organization by entering search criteria.

path Parameters
orgId
required
integer <int32>
query Parameters
employee_id
string
page
integer <int64>
size
integer <int64>
header Parameters
apikey
required
string

Responses