List adjustments

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/adjustments \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "adjustment",
      "data": {
        "source_line_item": {
          "id": "<id>",
          "object": "earning_line_item",
          "data": {
            "pay_stub": {
              "id": "<id>",
              "object": "pay_stub",
              "links": {
                "self": "/pay_stubs/<id>"
              }
            },
            "amount": 10000,
            "custom_amount": null,
            "managed_amount": 10000,
            "is_managed": true,
            "line_item_type": "earning",
            "earning_type": {
              "id": "<id>",
              "object": "earning_type",
              "data": {
                "type": "salary",
                "label": "Salary",
                "supported_payroll_types": {
                  "regular": true,
                  "historical": true,
                  "off_cycle": true
                }
              },
              "links": {
                "self": "/earning_types/salary"
              }
            },
            "hours": 173.33,
            "managed_hours": 173.33,
            "custom_hours": null,
            "accrued_vacation_pay": 0,
            "recurrence": {
              "id": "<id>",
              "object": "pay_rate",
              "links": {
                "self": "/pay_rates/<id>"
              }
            },
            "pay_rate": {
              "id": "<id>",
              "object": "pay_rate",
              "links": {
                "self": "/pay_rates/<id>"
              }
            },
            "overtime_rate": null,
            "title": "Salary Rate",
            "title_translations": null,
            "title_translated": "Salary Rate",
            "expense_accounting_code": null,
            "managed_expense_accounting_code": null,
            "custom_expense_accounting_code": null,
            "liability_accounting_code": null,
            "managed_liability_accounting_code": null,
            "custom_liability_accounting_code": null,
            "business_preset": null,
            "source_adjustment": null,
            "component_settings": {
              "attributes_locked": false
            },
            "earned_on": null,
            "managed_earned_on": null,
            "custom_earned_on": null,
            "external_ref": null,
            "created_at": "2026-01-01T00:00:00.000000Z",
            "updated_at": "2026-01-01T00:00:00.000000Z"
          },
          "links": {
            "self": "/earning_line_items/<id>"
          }
        },
        "correction_line_item": {
          "id": "<id>",
          "object": "earning_line_item",
          "data": {
            "pay_stub": {
              "id": "<id>",
              "object": "pay_stub",
              "links": {
                "self": "/pay_stubs/<id>"
              }
            },
            "amount": -8900,
            "custom_amount": null,
            "managed_amount": -8900,
            "is_managed": false,
            "line_item_type": "earning",
            "earning_type": {
              "id": "<id>",
              "object": "earning_type",
              "data": {
                "type": "salary",
                "label": "Salary",
                "supported_payroll_types": {
                  "regular": true,
                  "historical": true,
                  "off_cycle": true
                }
              },
              "links": {
                "self": "/earning_types/salary"
              }
            },
            "hours": null,
            "managed_hours": null,
            "custom_hours": null,
            "accrued_vacation_pay": 0,
            "recurrence": null,
            "pay_rate": null,
            "overtime_rate": null,
            "title": "Salary Rate Adjustment",
            "title_translations": {
              "en": "Salary Rate Adjustment",
              "fr": "Rajustement Salary Rate"
            },
            "title_translated": "Salary Rate Adjustment",
            "expense_accounting_code": null,
            "managed_expense_accounting_code": null,
            "custom_expense_accounting_code": null,
            "liability_accounting_code": null,
            "managed_liability_accounting_code": null,
            "custom_liability_accounting_code": null,
            "business_preset": null,
            "source_adjustment": {
              "id": "<id>",
              "object": "adjustment",
              "links": {
                "self": "/adjustments/<id>"
              }
            },
            "component_settings": {
              "attributes_locked": false
            },
            "earned_on": null,
            "managed_earned_on": null,
            "custom_earned_on": null,
            "external_ref": null,
            "created_at": "2026-01-01T00:00:00.000000Z",
            "updated_at": "2026-01-01T00:00:00.000000Z"
          },
          "links": {
            "self": "/earning_line_items/<id>"
          }
        },
        "correction_pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "type": "earning",
        "subtype": "salary",
        "expected_amount": 1100,
        "admin_note": null,
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/adjustments/<id>"
      }
    }
  ],
  "links": {
    "first": "/adjustments?correction_pay_stub_id=<id>&page=1",
    "last": "/adjustments?correction_pay_stub_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

GET

adjustments

List adjustments

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/adjustments \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "adjustment",
      "data": {
        "source_line_item": {
          "id": "<id>",
          "object": "earning_line_item",
          "data": {
            "pay_stub": {
              "id": "<id>",
              "object": "pay_stub",
              "links": {
                "self": "/pay_stubs/<id>"
              }
            },
            "amount": 10000,
            "custom_amount": null,
            "managed_amount": 10000,
            "is_managed": true,
            "line_item_type": "earning",
            "earning_type": {
              "id": "<id>",
              "object": "earning_type",
              "data": {
                "type": "salary",
                "label": "Salary",
                "supported_payroll_types": {
                  "regular": true,
                  "historical": true,
                  "off_cycle": true
                }
              },
              "links": {
                "self": "/earning_types/salary"
              }
            },
            "hours": 173.33,
            "managed_hours": 173.33,
            "custom_hours": null,
            "accrued_vacation_pay": 0,
            "recurrence": {
              "id": "<id>",
              "object": "pay_rate",
              "links": {
                "self": "/pay_rates/<id>"
              }
            },
            "pay_rate": {
              "id": "<id>",
              "object": "pay_rate",
              "links": {
                "self": "/pay_rates/<id>"
              }
            },
            "overtime_rate": null,
            "title": "Salary Rate",
            "title_translations": null,
            "title_translated": "Salary Rate",
            "expense_accounting_code": null,
            "managed_expense_accounting_code": null,
            "custom_expense_accounting_code": null,
            "liability_accounting_code": null,
            "managed_liability_accounting_code": null,
            "custom_liability_accounting_code": null,
            "business_preset": null,
            "source_adjustment": null,
            "component_settings": {
              "attributes_locked": false
            },
            "earned_on": null,
            "managed_earned_on": null,
            "custom_earned_on": null,
            "external_ref": null,
            "created_at": "2026-01-01T00:00:00.000000Z",
            "updated_at": "2026-01-01T00:00:00.000000Z"
          },
          "links": {
            "self": "/earning_line_items/<id>"
          }
        },
        "correction_line_item": {
          "id": "<id>",
          "object": "earning_line_item",
          "data": {
            "pay_stub": {
              "id": "<id>",
              "object": "pay_stub",
              "links": {
                "self": "/pay_stubs/<id>"
              }
            },
            "amount": -8900,
            "custom_amount": null,
            "managed_amount": -8900,
            "is_managed": false,
            "line_item_type": "earning",
            "earning_type": {
              "id": "<id>",
              "object": "earning_type",
              "data": {
                "type": "salary",
                "label": "Salary",
                "supported_payroll_types": {
                  "regular": true,
                  "historical": true,
                  "off_cycle": true
                }
              },
              "links": {
                "self": "/earning_types/salary"
              }
            },
            "hours": null,
            "managed_hours": null,
            "custom_hours": null,
            "accrued_vacation_pay": 0,
            "recurrence": null,
            "pay_rate": null,
            "overtime_rate": null,
            "title": "Salary Rate Adjustment",
            "title_translations": {
              "en": "Salary Rate Adjustment",
              "fr": "Rajustement Salary Rate"
            },
            "title_translated": "Salary Rate Adjustment",
            "expense_accounting_code": null,
            "managed_expense_accounting_code": null,
            "custom_expense_accounting_code": null,
            "liability_accounting_code": null,
            "managed_liability_accounting_code": null,
            "custom_liability_accounting_code": null,
            "business_preset": null,
            "source_adjustment": {
              "id": "<id>",
              "object": "adjustment",
              "links": {
                "self": "/adjustments/<id>"
              }
            },
            "component_settings": {
              "attributes_locked": false
            },
            "earned_on": null,
            "managed_earned_on": null,
            "custom_earned_on": null,
            "external_ref": null,
            "created_at": "2026-01-01T00:00:00.000000Z",
            "updated_at": "2026-01-01T00:00:00.000000Z"
          },
          "links": {
            "self": "/earning_line_items/<id>"
          }
        },
        "correction_pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "type": "earning",
        "subtype": "salary",
        "expected_amount": 1100,
        "admin_note": null,
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/adjustments/<id>"
      }
    }
  ],
  "links": {
    "first": "/adjustments?correction_pay_stub_id=<id>&page=1",
    "last": "/adjustments?correction_pay_stub_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

source_pay_stub_id

string

The source_pay_stub_id field is required when correction_pay_stub_id is not present.

correction_pay_stub_id

string

The correction_pay_stub_id field is required when source_pay_stub_id is not present.

external_ref

string

expand

enum<string>[]

Available options:

correction_line_item,

correction_pay_stub,

source_line_item

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Default · object

Default
With correction_pay_stub expanded

Hide child attributes

data.data.source_line_item

object

Hide child attributes

data.data.source_line_item.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.source_line_item.object

string

read-only

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

data.data.source_line_item.data

object

data.data.correction_line_item

object

Hide child attributes

data.data.correction_line_item.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.correction_line_item.object

string

read-only

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

data.data.correction_line_item.data

object

data.data.correction_pay_stub

object

Hide child attributes

data.data.correction_pay_stub.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.correction_pay_stub.object

string

read-only

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

data.data.type

string | null

Maximum string length: 255

data.data.subtype

string | null

Maximum string length: 255

data.data.expected_amount

number<decimal>

data.data.admin_note

string | null

data.data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Delete a statutory withholding line item Create an adjustment

⌘I