Deel: Invoice adjustments schemas
40 Deel schemas with complete fields and constraints.
← Invoice adjustments operations · All schemas
Create an invoice adjustment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object with identifiers, status, and creation metadata for the newly created invoice adjustment. |
created | boolean | Required within parent | Indicates whether the invoice adjustment record was successfully created by this request. |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | ISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system. Format: date-time |
created_at (anyOf 2) | null | Alternative | ISO-8601 timestamp recording the exact moment the invoice adjustment was created in the system. Format: date-time |
id | Model | Optional | Expand Create an invoice adjustment — 201 response body — data id Unique identifier returned for the created invoice adjustment resource after persistence succeeds. |
status | JSON | Optional | Current processing status assigned to the invoice adjustment after the create workflow finishes executing. |
status (anyOf 1) | string | Alternative | Current 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) | null | Alternative |
Referenced models: Create an invoice adjustment — 201 response body — data id
Create an invoice adjustment — 201 response body — data id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier returned for the created invoice adjustment resource after persistence succeeds. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create an invoice adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata. |
amount | number | Required within parent | Monetary amount to apply for this invoice adjustment, expressed in the contract currency as a positive number. Format: double Minimum: 0 |
contract_id | string | Required within parent | Unique Deel contract identifier (public id) that receives this invoice adjustment line item. |
date_submitted | string | Required within parent | Submission date in ISO-8601 short-date format (YYYY-MM-DD) used for filtering, reporting, and approvals. Format: date |
description | string | Required within parent | Detailed human-readable explanation that appears on invoices and audit records visible to both parties. Maximum length: 30000 |
group_key | string or null | Optional | When 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_id | string or null | Optional | Identifier of an existing hourly report preset used to link standardized rate and scale metadata to this entry. Format: uuid |
is_auto_approved | boolean | Optional | When true, the created invoice adjustment skips manual approval and is approved immediately on creation. |
paymentCycleId | string or null | Optional | Public id (UUID) of the active payment cycle required when creating VAT-related invoice adjustment entries against a specific cycle. Format: uuid |
type | string | Required within parent | Invoice 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Invoice line items by contract — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Required within parent | This object is used for linking file attachments to your records. |
attachment (anyOf 1) | Model | Alternative | Expand Attach a file to contract — 201 response body — data filename, key |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand Invoice line items by contract — 200 response body — data item contract Contract associated with this invoice adjustment. |
created_at | string | Required within parent | Timestamp when the adjustment was created (ISO-8601). Format: date-time |
currency_code | string | Required within parent | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client. |
date_submitted | string | Required within parent | Timestamp when the adjustment was submitted for review (ISO-8601). Format: date-time |
description | string | Required within parent | Human-readable explanation of the invoice adjustment. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
payment_cycle | Model | Required within parent | Expand Invoice line items by contract — 200 response body — data item payment cycle Payment cycle associated with this adjustment. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand Invoice line items by contract — 200 response body — data item reported by User who reported the invoice adjustment. |
reviewed_by | JSON | Required within parent | Reviewer information if the adjustment has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Invoice line items by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the adjustment amount. |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the adjustment amount. |
status | JSON | Required within parent | Current processing status of the invoice adjustment. |
status (anyOf 1) | string | Alternative | Current processing status of the invoice adjustment. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value of the invoice adjustment. |
type | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data type Type of invoice adjustment. |
worksheet | JSON | Required within parent | Breakdown of time worked across different units. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units |
worksheet (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract associated with this invoice adjustment. |
id | string | Required within parent | Unique identifier of the contract. |
title | string | Required within parent | Human-readable title of the contract. |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment cycle associated with this adjustment. |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | End date of the payment cycle (ISO-8601). Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the payment cycle (ISO-8601). Format: date-time |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Start date of the payment cycle (ISO-8601). Format: date-time |
start_date (anyOf 2) | null | Alternative | Start date of the payment cycle (ISO-8601). Format: date-time |
Invoice line items by contract — 200 response body — data item reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who reported the invoice adjustment. |
full_name | string | Optional | Full name of the user who reported the adjustment. |
id | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of the reporting user (string or integer). |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer information if the adjustment has been reviewed. |
full_name | string | Optional | Full name of the reviewer. |
id | Model | Required within parent | Expand 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). |
remarks | string | Required within parent | Reviewer remarks or decision notes. |
reviewed_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of the reviewer (string or integer). |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Invoice line items by contract — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the response. |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of items per page Format: double Maximum: 100 Minimum: 1 |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | number | Alternative | Index of the first row in this page Format: double Maximum: 999999999 Minimum: 0 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of rows in the result set Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List invoice adjustments — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of invoice adjustments returned for the request. |
data[] | Model | Each item | Expand List invoice adjustments — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Required within parent | File attachment linked to the invoice adjustment. |
attachment (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item attachment File attachment linked to the invoice adjustment |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item contract Contract associated with this invoice adjustment. |
created_at | string | Required within parent | Timestamp when the adjustment was created (ISO-8601). Format: date-time |
currency_code | JSON | Required within parent | |
currency_code (anyOf 1) | string | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client. |
date_submitted | JSON | Optional | |
date_submitted (anyOf 1) | string | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Timestamp when the adjustment was submitted for review. Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Human-readable explanation of the invoice adjustment. |
description (anyOf 2) | null | Alternative | Human-readable explanation of the invoice adjustment. |
hourlyReportPreset | JSON | Optional | |
hourlyReportPreset (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item hourly Report Preset id, rate, title |
hourlyReportPreset (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this invoice adjustment. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Identifier of the generated invoice this adjustment belongs to. Format: double |
payment_cycle | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item payment cycle Payment cycle associated with this adjustment. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand List invoice adjustments — 200 response body — data item reported by User who reported the invoice adjustment. |
reviewed_by | JSON | Required within parent | Reviewer information if the adjustment has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the adjustment amount. |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the adjustment amount. |
status | JSON | Required within parent | Current processing status of the invoice adjustment. |
status (anyOf 1) | string | Alternative | Current processing status of the invoice adjustment. Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value of the invoice adjustment. |
type | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data type Type of invoice adjustment. |
worksheet | JSON | Required within parent | Breakdown of time used for time-based calculations. |
worksheet (anyOf 1) | Model | Alternative | Expand List invoice adjustments — 200 response body — data item worksheet Breakdown of time used for time-based calculations |
worksheet (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File attachment linked to the invoice adjustment. |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Time-limited URL used to download the attachment. |
download_url (anyOf 2) | null | Alternative | Time-limited URL used to download the attachment. |
filename | string | Required within parent | Original filename of the uploaded attachment, download link can be found on the individual invoice adjustment endpoint |
key | string | Required within parent | Deprecated. 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract associated with this invoice adjustment. |
id | string | Required within parent | Unique identifier of the contract. |
title | string | Required within parent | Human-readable contract title. |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Id of assigned preset Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Assigned preset rate Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Assigned preset rate Format: double |
title | string | Optional | Description of assigned preset |
List invoice adjustments — 200 response body — data item payment cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment cycle associated with this adjustment. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the payment cycle. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the payment cycle. Format: date-time |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Start date of the payment cycle. Format: date-time |
start_date (anyOf 2) | null | Alternative | Start date of the payment cycle. Format: date-time |
List invoice adjustments — 200 response body — data item reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who reported the invoice adjustment. |
full_name | string | Optional | Full name of the reporting user. |
id | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer information if the adjustment has been reviewed. |
full_name | string | Optional | Full name of the reviewer. |
id | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id Unique identifier of the reviewer. |
remarks | JSON | Required within parent | |
remarks (anyOf 1) | string | Alternative | Reviewer remarks or decision notes. |
remarks (anyOf 2) | null | Alternative | Reviewer remarks or decision notes. |
reviewed_at | JSON | Required within parent | |
reviewed_at (anyOf 1) | string | Alternative | Timestamp when the review occurred. |
reviewed_at (anyOf 2) | null | Alternative | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Breakdown of time used for time-based calculations. |
days | JSON | Required within parent | |
days (anyOf 1) | number | Alternative | Number of days reported. Format: double |
days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours | JSON | Required within parent | |
hours (anyOf 1) | number | Alternative | Number of hours reported. Format: double |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minutes | JSON | Required within parent | |
minutes (anyOf 1) | number | Alternative | Number of minutes reported. Format: double |
minutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
weeks | JSON | Required within parent | |
weeks (anyOf 1) | number | Alternative | Number of weeks reported. Format: double |
weeks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List invoice adjustments — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the response. |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of records returned per page. Format: double Maximum: 100 Minimum: 1 |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | number | Alternative | Index of the first record in the current page. Format: double Maximum: 999999999 Minimum: 0 |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of records available. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List invoice adjustments — request body — query types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approvers | array | Optional | |
approvers[] | Model | Each item | Expand Retrieve invoice adjustment by ID — 200 response body — data approvers item |
attachment | JSON | Required within parent | File attachment linked to the invoice adjustment. |
attachment (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data contract |
created_at | string | Required within parent | Long date-time format following ISO-8601 Format: date-time |
currency_code | JSON | Required within parent | |
currency_code (anyOf 1) | string | Alternative | Three-letter ISO-4217 currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Three-letter ISO-4217 currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | A custom unit of measurement if the standard 'scale' is not applicable. |
custom_scale (anyOf 2) | null | Alternative | A custom unit of measurement if the standard 'scale' is not applicable. |
date_submitted | JSON | Required within parent | |
date_submitted (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
description | string | Required within parent | Details or notes regarding the adjustment. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of this resource. Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier of this resource. Format: uuid |
invoice_id | JSON | Optional | |
invoice_id (anyOf 1) | JSON | Alternative | |
invoice_id (anyOf 1) (anyOf 1) | number | Alternative | Deprecated. No longer used Format: double |
invoice_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invoice_id (anyOf 2) | null | Alternative | Deprecated. No longer used Format: double |
invoice_public_id | JSON | Optional | |
invoice_public_id (anyOf 1) | string | Alternative | Public Identifier for the associated invoice. |
invoice_public_id (anyOf 2) | null | Alternative | Public Identifier for the associated invoice. |
payment_cycle | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data payment cycle |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity/number of units applied. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | The quantity/number of units applied. Format: double |
reported_by | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data reported by The user who reported/submitted the adjustment. |
reviewed_by | JSON | Required within parent | The user who reviewed the adjustment. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data reviewed by The user who reviewed the adjustment |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The scale used for calculation (e.g., hourly, daily). |
scale (anyOf 2) | null | Alternative | The scale used for calculation (e.g., hourly, daily). |
status | JSON | Required within parent | status of invoice adjustment |
status (anyOf 1) | string | Alternative | status of invoice adjustment Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | The total monetary value of the adjustment. |
type | Model | Required within parent | Expand Retrieve invoice adjustment by ID — 200 response body — data type Type of invoice adjustment. |
worksheet | JSON | Required within parent | Breakdown of the time/effort involved in the adjustment. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve invoice adjustment by ID — 200 response body — data worksheet days, hours, minutes, weeks |
worksheet (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved | boolean | Required within parent | Whether the specific approver has approved the adjustment. |
email | string | Optional | Email address of the approver. |
full_name | string | Optional | Full name of the approver. |
Retrieve invoice adjustment by ID — 200 response body — data attachment File attachment linked to the invoice adjustment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File attachment linked to the invoice adjustment. |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | URL used to download the uploaded attachment file. |
download_url (anyOf 2) | null | Alternative | URL used to download the uploaded attachment file. |
filename | string | Required within parent | Original filename of the uploaded attachment |
key | string | Required within parent | Deprecated. 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the contract. |
title | string | Required within parent | The display title of the contract. |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
end_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
Retrieve invoice adjustment by ID — 200 response body — data reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The user who reported/submitted the adjustment. |
full_name | string | Optional | Full name of the reporter. |
id | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The user who reviewed the adjustment. |
full_name | string | Optional | Full name of the reviewer. |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
remarks | string | Required within parent | Comments or notes left by the reviewer. |
reviewed_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Breakdown of the time/effort involved in the adjustment. |
days | JSON | Required within parent | |
days (anyOf 1) | number | Alternative | Number of days. Format: double Minimum: 0 |
days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours | JSON | Required within parent | |
hours (anyOf 1) | number | Alternative | Number of hours. Format: double Minimum: 0 |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minutes | JSON | Required within parent | |
minutes (anyOf 1) | number | Alternative | Number of minutes. Format: double Minimum: 0 |
minutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
weeks | JSON | Required within parent | |
weeks (anyOf 1) | number | Alternative | Number of weeks. Format: double Minimum: 0 |
weeks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Submit a review decision for an invoice adjustment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Confirms the review was applied to the invoice adjustment. |
Submit a review decision for an invoice adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | string or null | Optional | The reason for the adjustment update. Maximum length: 200 |
status | string | Required within parent | The status of the adjustment. One of: approved, declined |
Update an invoice adjustment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
updated | boolean | Required within parent | Confirms the update. |
Update an invoice adjustment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of adjustment to update |
amount | number | Optional | Amount of adjustment. Format: double |
description | string | Optional | Description of adjustment. |
title | string | Optional | Title of adjustment. |