NMnmbr
Employee Benefits

Search employee benefits

Changed on

Search benefits under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.

post/employee_benefits/search

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Request body

business_entity_idstring required
has_business_presetboolean
effective_onstring date
not_effective_onstring date
effective_fromstring

The date from which this benefit is applied to Pay Stubs.

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_tostring

The date after which this benefit is no longer applied. null if the benefit applies indefinitely.

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

Response

OK

objectstring

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

Changes

  • fd2d967d9df4Revision changes
    • warning

      added the new fixed_per_hour enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • e0954625b417Revision changes
    • warning

      added the new grossable enum value to the /////// response property for the response status

    • warning

      added the new included_in_gross_pay enum value to the ////////// response property for the response status