Skip to main content
POST
Create an adjustment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
correction_pay_stub_id
string
required
expected_amount
number<decimal>
required
Required range: -99999 <= x <= 99999
source_line_item_id
string

Must be present when type and subtype is either empty or not set.

is_company_amount
boolean
type
enum<string>

Must be present when source_line_item_id is either empty or not set.

Available options:
allowance,
deduction,
earning,
employee_benefit,
employer_benefit,
employer_statutory_withholding,
reimbursement,
statutory_withholding
subtype
string

Must be present when source_line_item_id is either empty or not set.

admin_note
string | null
external_ref
string
Maximum string length: 255

Response

201 - application/json

Created

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

The type of the object in Nmbr ("adjustment").

data
Adjustment · object