Skip to main content

Updating hours worked

The Nmbr API surfaces an endpoint that can be used to import hours for many employees at once.

Supported Earning Types

The supported earning line item types are:
  • wage (multiple require a pay_rate_id and/or earned_on)
  • salary (multiple require a pay_rate_id and/or earned_on)
  • overtime (multiple require an overtime_rate_id, rate_multiplier, and/or earned_on)
  • vacation_pay (multiple require a pay_rate_id and/or earned_on)

Simple Scenario

In this simple scenario, each employee has been configured with a single Pay Rate. To run payroll accurately, you will be required to update the hours for each Earning Line Item generated from the Pay Rates. To cut down on API calls, use the POST /payrolls/{payroll}/hours endpoint to import hours for multiple employees at once.

A More Complex Scenario

In some cases, employees may have multiple Pay Rates and Overtime Rates, resulting in many Earning Line Items. In order for the system to know which hours correspond with each Earning Line Item, the API requires you to provide either a pay_rate_id, overtime_rate_id, or rate_multiplier, depending on the type of earning.

Tracking Hours by Date

If you track hours per day (or any other date granularity within the payroll period), you can attach an earned_on date to each entry. This is supported on every earning type. The earned_on value:
  • Must be a date that falls within the payroll’s pay period.
  • Is part of the entry’s scoping key, so you can submit multiple entries against the same pay_rate_id (or overtime_rate_id / rate_multiplier) as long as their earned_on dates differ.

Targeting a Business Preset

When you import hours for distinct configured workflows that share an earning type and rate, include business_preset_id on each earning entry. The preset identifies which line item to update or create. The preset must belong to the payroll’s business entity, have the earning type, and match the entry’s earning type when the preset has a subtype.
The preset is part of the matching key. Re-send the same earning type, rate, date, and preset to update the same line item. Use a different compatible preset to keep the line items separate. Requests without business_preset_id keep their existing matching behaviour. See Presets to create and manage Business Presets.