NMnmbr
Vacation Pay Settings

List vacation pay settings

Changed on
get/vacation_pay_settings

Request

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

Query parameters

business_entity_idstring
work_assignment_idstring
employee_idstring
effective_onstring date
not_effective_onstring date
effective_fromobject

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_toobject

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
search_payee_namesstring
sort'effective_from' | 'effective_to' | 'work_assignment.payee.default' | 'work_assignment.payee.first_name' | 'work_assignment.payee.last_name'

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).

expandstring[]

Response

OK

objectstring

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

Changes

  • 5b24aa3d933fRevision changes
    • info

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

    • info

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

  • 62832e263f3aRevision changes
    • info

      added the enum value business_preset to the property items/ of the query request parameter expand

    • info

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

    • info

      added subschema #3: With business_preset expanded to the // response property anyOf list for the response status