Skip to content

Deel: Invoice adjustments schemas

40 Deel schemas with complete fields and constraints.

← Invoice adjustments operations · All schemas

Create an invoice adjustment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an invoice adjustment — 201 response body — data
Container object with identifiers, status, and creation metadata for the newly created invoice adjustment.

Referenced models: Create an invoice adjustment — 201 response body — data

Create an invoice adjustment — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootContainer object with identifiers, status, and creation metadata for the newly created invoice adjustment.
createdbooleanRequired within parentIndicates whether the invoice adjustment record was successfully created by this request.
created_atJSONOptional
created_at (anyOf 1)stringAlternativeISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system.
Format: date-time
created_at (anyOf 2)nullAlternativeISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system.
Format: date-time
idModelOptionalExpand Create an invoice adjustment — 201 response body — data id
Unique identifier returned for the created invoice adjustment resource after persistence succeeds.
statusJSONOptionalCurrent processing status assigned to the invoice adjustment after the create workflow finishes executing.
status (anyOf 1)stringAlternativeCurrent processing status assigned to the invoice adjustment after the create workflow finishes executing.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

Referenced models: Create an invoice adjustment — 201 response body — data id

Create an invoice adjustment — 201 response body — data id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier returned for the created invoice adjustment resource after persistence succeeds.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create an invoice adjustment — request body — body data

FieldTypePresenceDescription and constraints
$objectRootPayload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.
amountnumberRequired within parentMonetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number.
Format: double
Minimum: 0
contract_idstringRequired within parentUnique Deel contract identifier (public id) that receives this invoice adjustment line item.
date_submittedstringRequired within parentSubmission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals.
Format: date
descriptionstringRequired within parentDetailed human-readable explanation that appears on invoices and audit records visible to both parties.
Maximum length: 30000
group_keystring or nullOptionalWhen provided, invoice adjustments sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true.
Maximum length: 300
hourly_report_preset_idstring or nullOptionalIdentifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry.
Format: uuid
is_auto_approvedbooleanOptionalWhen true, the created invoice adjustment skips manual approval and is approved immediately on creation.
paymentCycleIdstring or nullOptionalPublic id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle.
Format: uuid
typestringRequired within parentInvoice adjustment category that determines business rules and downstream invoicing behavior.
One of: bonus, commission, deduction, expense, other, overtime, time_off, vat

Invoice line items by contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Invoice line items by contract — 200 response body — data item
pageModelRequired within parentExpand Invoice line items by contract — 200 response body — page
Pagination metadata for the response.

Referenced models: Invoice line items by contract — 200 response body — data item, Invoice line items by contract — 200 response body — page

Invoice line items by contract — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentJSONRequired within parentThis object is used for linking file attachments to your records.
attachment (anyOf 1)ModelAlternativeExpand Attach a file to contract — 201 response body — data filename, key
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand Invoice line items by contract — 200 response body — data item contract
Contract associated with this invoice adjustment.
created_atstringRequired within parentTimestamp when the adjustment was created (ISO-8601).
Format: date-time
currency_codestringRequired within parentISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client.
date_submittedstringRequired within parentTimestamp when the adjustment was submitted for review (ISO-8601).
Format: date-time
descriptionstringRequired within parentHuman-readable explanation of the invoice adjustment.
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of this invoice adjustment.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this invoice adjustment.
Format: uuid
invoice_idJSONOptional
invoice_id (anyOf 1)JSONAlternative
invoice_id (anyOf 1) (anyOf 1)numberAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
invoice_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invoice_id (anyOf 2)nullAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
payment_cycleModelRequired within parentExpand Invoice line items by contract — 200 response body — data item payment cycle
Payment cycle associated with this adjustment.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand Invoice line items by contract — 200 response body — data item reported by
User who reported the invoice adjustment.
reviewed_byJSONRequired within parentReviewer information if the adjustment has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the adjustment amount.
scale (anyOf 2)nullAlternativePredefined scale used to calculate the adjustment amount.
statusJSONRequired within parentCurrent processing status of the invoice adjustment.
status (anyOf 1)stringAlternativeCurrent processing status of the invoice adjustment.
Known values: approved, declined, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentTotal monetary value of the invoice adjustment.
typeModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data type
Type of invoice adjustment.
worksheetJSONRequired within parentBreakdown of time worked across different units.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units
worksheet (anyOf 2)nullAlternative

Referenced models: Attach a file to contract — 201 response body — data filename, key, Invoice line items by contract — 200 response body — data item contract, Invoice line items by contract — 200 response body — data item payment cycle, Invoice line items by contract — 200 response body — data item reported by, Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at, Retrieve invoice adjustment by ID — 200 response body — data type, Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units

Invoice line items by contract — 200 response body — data item contract

FieldTypePresenceDescription and constraints
$objectRootContract associated with this invoice adjustment.
idstringRequired within parentUnique identifier of the contract.
titlestringRequired within parentHuman-readable title of the contract.
typestringRequired within parentType of a contract
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo

Invoice line items by contract — 200 response body — data item payment cycle

FieldTypePresenceDescription and constraints
$objectRootPayment cycle associated with this adjustment.
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeEnd date of the payment cycle (ISO-8601).
Format: date-time
end_date (anyOf 2)nullAlternativeEnd date of the payment cycle (ISO-8601).
Format: date-time
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeStart date of the payment cycle (ISO-8601).
Format: date-time
start_date (anyOf 2)nullAlternativeStart date of the payment cycle (ISO-8601).
Format: date-time

Invoice line items by contract — 200 response body — data item reported by

FieldTypePresenceDescription and constraints
$objectRootUser who reported the invoice adjustment.
full_namestringOptionalFull name of the user who reported the adjustment.
idModelRequired within parentExpand Invoice line items by contract — 200 response body — data item reported by id
Unique identifier of the reporting user (string or integer).

Referenced models: Invoice line items by contract — 200 response body — data item reported by id

Invoice line items by contract — 200 response body — data item reported by id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of the reporting user (string or integer).
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at

FieldTypePresenceDescription and constraints
$objectRootReviewer information if the adjustment has been reviewed.
full_namestringOptionalFull name of the reviewer.
idModelRequired within parentExpand Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at id
Unique identifier of the reviewer (string or integer).
remarksstringRequired within parentReviewer remarks or decision notes.
reviewed_atstringRequired within parentTimestamp when the review occurred (ISO-8601).

Referenced models: Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at id

Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of the reviewer (string or integer).
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Invoice line items by contract — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of items per page
Format: double
Maximum: 100
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeIndex of the first row in this page
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows in the result set
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List invoice adjustments — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of invoice adjustments returned for the request.
data[]ModelEach itemExpand List invoice adjustments — 200 response body — data item
pageModelRequired within parentExpand List invoice adjustments — 200 response body — page
Pagination metadata for the response.

Referenced models: List invoice adjustments — 200 response body — data item, List invoice adjustments — 200 response body — page

List invoice adjustments — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentJSONRequired within parentFile attachment linked to the invoice adjustment.
attachment (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand List invoice adjustments — 200 response body — data item contract
Contract associated with this invoice adjustment.
created_atstringRequired within parentTimestamp when the adjustment was created (ISO-8601).
Format: date-time
currency_codeJSONRequired within parent
currency_code (anyOf 1)stringAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client.
date_submittedJSONOptional
date_submitted (anyOf 1)stringAlternativeTimestamp when the adjustment was submitted for review.
Format: date-time
date_submitted (anyOf 2)nullAlternativeTimestamp when the adjustment was submitted for review.
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeHuman-readable explanation of the invoice adjustment.
description (anyOf 2)nullAlternativeHuman-readable explanation of the invoice adjustment.
hourlyReportPresetJSONOptional
hourlyReportPreset (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title
hourlyReportPreset (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of this invoice adjustment.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this invoice adjustment.
Format: uuid
invoice_idJSONOptional
invoice_id (anyOf 1)JSONAlternative
invoice_id (anyOf 1) (anyOf 1)numberAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
invoice_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invoice_id (anyOf 2)nullAlternativeIdentifier of the generated invoice this adjustment belongs to.
Format: double
payment_cycleModelRequired within parentExpand List invoice adjustments — 200 response body — data item payment cycle
Payment cycle associated with this adjustment.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand List invoice adjustments — 200 response body — data item reported by
User who reported the invoice adjustment.
reviewed_byJSONRequired within parentReviewer information if the adjustment has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the adjustment amount.
scale (anyOf 2)nullAlternativePredefined scale used to calculate the adjustment amount.
statusJSONRequired within parentCurrent processing status of the invoice adjustment.
status (anyOf 1)stringAlternativeCurrent processing status of the invoice adjustment.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentTotal monetary value of the invoice adjustment.
typeModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data type
Type of invoice adjustment.
worksheetJSONRequired within parentBreakdown of time used for time-based calculations.
worksheet (anyOf 1)ModelAlternativeExpand List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations
worksheet (anyOf 2)nullAlternative

Referenced models: Retrieve invoice adjustment by ID — 200 response body — data type, List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment, List invoice adjustments — 200 response body — data item contract, List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title, List invoice adjustments — 200 response body — data item payment cycle, List invoice adjustments — 200 response body — data item reported by, List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at, List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations

List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment

FieldTypePresenceDescription and constraints
$objectRootFile attachment linked to the invoice adjustment.
download_urlJSONOptional
download_url (anyOf 1)stringAlternativeTime-limited URL used to download the attachment.
download_url (anyOf 2)nullAlternativeTime-limited URL used to download the attachment.
filenamestringRequired within parentOriginal filename of the uploaded attachment, download link can be found on the individual invoice adjustment endpoint
keystringRequired within parentDeprecated. Legacy storage key; empty when the attachment is held by the file service. Use download_url to retrieve the file.

List invoice adjustments — 200 response body — data item contract

FieldTypePresenceDescription and constraints
$objectRootContract associated with this invoice adjustment.
idstringRequired within parentUnique identifier of the contract.
titlestringRequired within parentHuman-readable contract title.
typestringRequired within parentType of the contract.
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, gp_client_agreement, shield_msa, hris_direct_employee, peo

List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalId of assigned preset
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeAssigned preset rate
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeAssigned preset rate
Format: double
titlestringOptionalDescription of assigned preset

List invoice adjustments — 200 response body — data item payment cycle

FieldTypePresenceDescription and constraints
$objectRootPayment cycle associated with this adjustment.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the payment cycle.
Format: date-time
end_date (anyOf 2)nullAlternativeEnd date of the payment cycle.
Format: date-time
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeStart date of the payment cycle.
Format: date-time
start_date (anyOf 2)nullAlternativeStart date of the payment cycle.
Format: date-time

List invoice adjustments — 200 response body — data item reported by

FieldTypePresenceDescription and constraints
$objectRootUser who reported the invoice adjustment.
full_namestringOptionalFull name of the reporting user.
idModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data reported by id
Unique identifier of the reporting user.

Referenced models: Retrieve a single timesheet entry — 200 response body — data reported by id

List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at

FieldTypePresenceDescription and constraints
$objectRootReviewer information if the adjustment has been reviewed.
full_namestringOptionalFull name of the reviewer.
idModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id
Unique identifier of the reviewer.
remarksJSONRequired within parent
remarks (anyOf 1)stringAlternativeReviewer remarks or decision notes.
remarks (anyOf 2)nullAlternativeReviewer remarks or decision notes.
reviewed_atJSONRequired within parent
reviewed_at (anyOf 1)stringAlternativeTimestamp when the review occurred.
reviewed_at (anyOf 2)nullAlternativeTimestamp when the review occurred.

Referenced models: Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id

List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations

FieldTypePresenceDescription and constraints
$objectRootBreakdown of time used for time-based calculations.
daysJSONRequired within parent
days (anyOf 1)numberAlternativeNumber of days reported.
Format: double
days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursJSONRequired within parent
hours (anyOf 1)numberAlternativeNumber of hours reported.
Format: double
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minutesJSONRequired within parent
minutes (anyOf 1)numberAlternativeNumber of minutes reported.
Format: double
minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weeksJSONRequired within parent
weeks (anyOf 1)numberAlternativeNumber of weeks reported.
Format: double
weeks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List invoice adjustments — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of records returned per page.
Format: double
Maximum: 100
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeIndex of the first record in the current page.
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of records available.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List invoice adjustments — request body — query types item

FieldTypePresenceDescription and constraints
$stringRootType of invoice adjustment.
One of: accrued_holiday, additional_fee, allowance, bonus, commission, deduction, deposit, deposit_refund, employer_cost, expense, health_allowance, health_benefit, health_insurance_fee, legal_fee, management_fee, milestone, offcycle, other, overtime, pension, pro_rata, setup_fee, severance, shield_service, signing_bonus, signing_bonus_employer_cost, refund, task, time_off, vat, withholding_tax, work

Retrieve invoice adjustment by ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data

Referenced models: Retrieve invoice adjustment by ID — 200 response body — data

Retrieve invoice adjustment by ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
approversarrayOptional
approvers[]ModelEach itemExpand Retrieve invoice adjustment by ID — 200 response body — data approvers item
attachmentJSONRequired within parentFile attachment linked to the invoice adjustment.
attachment (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data contract
created_atstringRequired within parentLong date-time format following ISO-8601
Format: date-time
currency_codeJSONRequired within parent
currency_code (anyOf 1)stringAlternativeThree-letter ISO-4217 currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeThree-letter ISO-4217 currency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeA custom unit of measurement if the standard 'scale' is not applicable.
custom_scale (anyOf 2)nullAlternativeA custom unit of measurement if the standard 'scale' is not applicable.
date_submittedJSONRequired within parent
date_submitted (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
date_submitted (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
descriptionstringRequired within parentDetails or notes regarding the adjustment.
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
invoice_idJSONOptional
invoice_id (anyOf 1)JSONAlternative
invoice_id (anyOf 1) (anyOf 1)numberAlternativeDeprecated. No longer used
Format: double
invoice_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invoice_id (anyOf 2)nullAlternativeDeprecated. No longer used
Format: double
invoice_public_idJSONOptional
invoice_public_id (anyOf 1)stringAlternativePublic Identifier for the associated invoice.
invoice_public_id (anyOf 2)nullAlternativePublic Identifier for the associated invoice.
payment_cycleModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data payment cycle
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeThe quantity/number of units applied.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeThe quantity/number of units applied.
Format: double
reported_byModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data reported by
The user who reported/submitted the adjustment.
reviewed_byJSONRequired within parentThe user who reviewed the adjustment.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe scale used for calculation (e.g., hourly, daily).
scale (anyOf 2)nullAlternativeThe scale used for calculation (e.g., hourly, daily).
statusJSONRequired within parentstatus of invoice adjustment
status (anyOf 1)stringAlternativestatus of invoice adjustment
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentThe total monetary value of the adjustment.
typeModelRequired within parentExpand Retrieve invoice adjustment by ID — 200 response body — data type
Type of invoice adjustment.
worksheetJSONRequired within parentBreakdown of the time/effort involved in the adjustment.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks
worksheet (anyOf 2)nullAlternative

Referenced models: Retrieve invoice adjustment by ID — 200 response body — data approvers item, Retrieve invoice adjustment by ID — 200 response body — data type, Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment, Retrieve invoice adjustment by ID — 200 response body — data contract, Retrieve invoice adjustment by ID — 200 response body — data payment cycle, Retrieve invoice adjustment by ID — 200 response body — data reported by, Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment, Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks

Retrieve invoice adjustment by ID — 200 response body — data approvers item

FieldTypePresenceDescription and constraints
$objectRoot
approvedbooleanRequired within parentWhether the specific approver has approved the adjustment.
emailstringOptionalEmail address of the approver.
full_namestringOptionalFull name of the approver.

Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment

FieldTypePresenceDescription and constraints
$objectRootFile attachment linked to the invoice adjustment.
download_urlJSONOptional
download_url (anyOf 1)stringAlternativeURL used to download the uploaded attachment file.
download_url (anyOf 2)nullAlternativeURL used to download the uploaded attachment file.
filenamestringRequired within parentOriginal filename of the uploaded attachment
keystringRequired within parentDeprecated. Legacy storage key; empty when the attachment is held by the file service. Use download_url to retrieve the file.

Retrieve invoice adjustment by ID — 200 response body — data contract

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the contract.
titlestringRequired within parentThe display title of the contract.
typestringRequired within parentType of a contract
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, gp_client_agreement, shield_msa, hris_direct_employee, peo

Retrieve invoice adjustment by ID — 200 response body — data payment cycle

FieldTypePresenceDescription and constraints
$objectRoot
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
end_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time

Retrieve invoice adjustment by ID — 200 response body — data reported by

FieldTypePresenceDescription and constraints
$objectRootThe user who reported/submitted the adjustment.
full_namestringOptionalFull name of the reporter.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id

Referenced models: Retrieve a single milestone — 200 response body — data id

Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment

FieldTypePresenceDescription and constraints
$objectRootThe user who reviewed the adjustment.
full_namestringOptionalFull name of the reviewer.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
remarksstringRequired within parentComments or notes left by the reviewer.
reviewed_atstringRequired within parentThe timestamp when the review occurred.

Referenced models: Retrieve a single milestone — 200 response body — data id

Retrieve invoice adjustment by ID — 200 response body — data type

FieldTypePresenceDescription and constraints
$stringRootType of invoice adjustment.
Known values: accrued_holiday, additional_fee, allowance, bonus, commission, deduction, deposit, deposit_refund, employer_cost, expense, health_allowance, health_benefit, health_insurance_fee, legal_fee, management_fee, milestone, offcycle, other, overtime, pension, pro_rata, setup_fee, severance, shield_service, signing_bonus, signing_bonus_employer_cost, refund, task, time_off, vat, withholding_tax, work

Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks

FieldTypePresenceDescription and constraints
$objectRootBreakdown of the time/effort involved in the adjustment.
daysJSONRequired within parent
days (anyOf 1)numberAlternativeNumber of days.
Format: double
Minimum: 0
days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursJSONRequired within parent
hours (anyOf 1)numberAlternativeNumber of hours.
Format: double
Minimum: 0
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minutesJSONRequired within parent
minutes (anyOf 1)numberAlternativeNumber of minutes.
Format: double
Minimum: 0
minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weeksJSONRequired within parent
weeks (anyOf 1)numberAlternativeNumber of weeks.
Format: double
Minimum: 0
weeks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Submit a review decision for an invoice adjustment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Submit a review decision for an invoice adjustment — 201 response body — data

Referenced models: Submit a review decision for an invoice adjustment — 201 response body — data

Submit a review decision for an invoice adjustment — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentConfirms the review was applied to the invoice adjustment.

Submit a review decision for an invoice adjustment — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
reasonstring or nullOptionalThe reason for the adjustment update.
Maximum length: 200
statusstringRequired within parentThe status of the adjustment.
One of: approved, declined

Update an invoice adjustment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update an invoice adjustment — 200 response body — data

Referenced models: Update an invoice adjustment — 200 response body — data

Update an invoice adjustment — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
updatedbooleanRequired within parentConfirms the update.

Update an invoice adjustment — request body — body data

FieldTypePresenceDescription and constraints
$objectRootDetails of adjustment to update
amountnumberOptionalAmount of adjustment.
Format: double
descriptionstringOptionalDescription of adjustment.
titlestringOptionalTitle of adjustment.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.