Skip to main content
GET
/
earnings
List earnings
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/earnings \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "earning",
      "data": {
        "work_assignment": {
          "id": "<id>",
          "object": "work_assignment",
          "links": {
            "self": "/work_assignments/<id>"
          }
        },
        "earning_type": {
          "id": "<id>",
          "object": "earning_type",
          "data": {
            "type": "parental_top_up_insurable",
            "label": "Parental Top-Up (Insurable)",
            "supported_payroll_types": {
              "regular": true,
              "historical": true,
              "off_cycle": true
            }
          },
          "links": {
            "self": "/earning_types/parental_top_up_insurable"
          }
        },
        "title": null,
        "title_translations": null,
        "title_translated": null,
        "amount": 5000,
        "frequency": "per_payroll",
        "date_basis": null,
        "pay_period_cadence": null,
        "effective_from": "2026-01-01",
        "effective_to": null,
        "business_preset": null,
        "expense_accounting_code": null,
        "liability_accounting_code": null,
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/earnings/<id>"
      }
    }
  ],
  "links": {
    "first": "/earnings?work_assignment_id=<id>&page=1",
    "last": "/earnings?work_assignment_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

​
business_entity_id
string
​
pay_schedule_id
string
​
work_assignment_id
string
​
employee_id
string
​
has_business_preset
boolean
​
business_preset_id
string
​
include_types
enum<string>
Available options:
bonus_discretionary,
bonus_non_discretionary,
bonus_non_taxable,
commission,
commission_periodic,
commission_self_employed,
death_benefit,
gift_cash,
gratuity,
in_lieu_wages,
income_replacement_indemnity_non_taxable,
income_replacement_indemnity_taxable,
invoice_payment,
invoice_sales_tax,
leave_bereavement,
leave_domestic_and_sexual_violence,
leave_general,
leave_paternity,
leave_personal,
leave_sick,
leave_voting,
leave_wedding,
overtime,
parental_top_up_insurable,
parental_top_up_non_insurable,
pension,
retiring_allowance,
retiring_allowance_eligible,
retroactive_pay,
retroactive_pay_increase,
salary,
salary_continuance,
severance_pay,
statutory_holiday_pay,
supplemental_unemployment,
vacation_accrual_adjustment,
vacation_pay,
vacation_pay_employee_terminated,
vacation_pay_no_time_taken,
vacation_pay_time_taken,
wage
​
exclude_types
enum<string>
Available options:
bonus_discretionary,
bonus_non_discretionary,
bonus_non_taxable,
commission,
commission_periodic,
commission_self_employed,
death_benefit,
gift_cash,
gratuity,
in_lieu_wages,
income_replacement_indemnity_non_taxable,
income_replacement_indemnity_taxable,
invoice_payment,
invoice_sales_tax,
leave_bereavement,
leave_domestic_and_sexual_violence,
leave_general,
leave_paternity,
leave_personal,
leave_sick,
leave_voting,
leave_wedding,
overtime,
parental_top_up_insurable,
parental_top_up_non_insurable,
pension,
retiring_allowance,
retiring_allowance_eligible,
retroactive_pay,
retroactive_pay_increase,
salary,
salary_continuance,
severance_pay,
statutory_holiday_pay,
supplemental_unemployment,
vacation_accrual_adjustment,
vacation_pay,
vacation_pay_employee_terminated,
vacation_pay_no_time_taken,
vacation_pay_time_taken,
wage
​
effective_on
string<date>
​
not_effective_on
string<date>
​
effective_from
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_from=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31
​
effective_to
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_to=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31
​
external_ref
string
​
search_payee_names
string
​
sort
enum<string>

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

Available options:
effective_from,
effective_to,
work_assignment.payee.default,
work_assignment.payee.first_name,
work_assignment.payee.last_name
​
tag_id
string
​
tag_group_id
string
​
expand
enum<string>[]
Available options:
business_preset,
expense_accounting_code,
liability_accounting_code,
tag_assignment,
work_assignment

Response

200 - application/json

OK

​
object
string
read-only

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

​
data
object[]