API Data Provider - Online Help

Adjustments

Retrieve payment adjustments such as bonuses, deductions, reimbursements, or allowances applied to worker contracts.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique adjustment identifier

ContractId String True

Associated contract identifier

AdjustmentCategoryId String True

AdjustmentCategories.Id

Category identifier

Title String True

Short title describing the adjustment purpose

Status String True

Processing status of the adjustment (approval workflow and payment state)

The allowed values are open, pending_approval, success, APPROVED, REIMBURSED, REJECTED, PAID, PENDING, PROCESSING, CANCELLED, FAILED, EXPIRED, COMPLETED, REFUNDED.

Amount Decimal True

Monetary value of the adjustment (positive for additions, negative for deductions)

Description String True

Detailed explanation of why the adjustment was made

DateOfAdjustment Datetime True

Date when the adjustment takes effect or was applied

CreatedAt Datetime True

Creation timestamp

UpdatedAt Datetime True

Last update timestamp

CycleReference String True

Associated payroll cycle reference

CanMoveToNextCycle Boolean True

Whether adjustment can be moved to the next payroll cycle if not processed

ActualStartCycleDate Datetime True

Start date of the payroll cycle this adjustment belongs to

ActualEndCycleDate Datetime True

End date of the payroll cycle this adjustment belongs to

File String True

Supporting document attached to adjustment (receipt, invoice, or approval form)

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0