BIbindbee
Payroll Runs

Get Payroll Run By Id

Changed on

Returns a PayrollRun object with the given id.

get/api/hris/v1/payroll-runs/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

pay_groupstring nullable required

The paygroup to which this pay cycle belongs to

run_statestring nullable required

The state of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.

run_typestring nullable required

The type of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.

start_datestring nullable required

The day and time the payroll run started.

end_datestring nullable required

The day and time the payroll run ended.

check_datestring nullable required

The day and time the payroll run was checked.

payroll_run_calendarstring nullable required

The payroll run calendar to which which the payroll run belongs

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "pay_group": "018af1fe-2fad-749e-a282-ea17ba4fc0c4",
  "run_state": "PAID",
  "run_type": "REGULAR",
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-15T00:00:00Z",
  "check_date": "2020-11-15T00:00:00Z",
  "payroll_run_calendar": "018af1fe-2fad-749e-a282-ea17ba4fc0c4"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the APPROVED enum value from the response property for the response status

    • info

      removed the BONUS enum value from the response property for the response status

    • info

      removed the CLOSED enum value from the response property for the response status

    • info

      removed the CORRECTION enum value from the response property for the response status

    • info

      removed the DRAFT enum value from the response property for the response status

    • info

      removed the FAILED enum value from the response property for the response status

    • info

      removed the NOT_STARTED enum value from the response property for the response status

    • info

      removed the OFF_CYCLE enum value from the response property for the response status

    • info

      removed the PAID enum value from the response property for the response status

    • info

      removed the REGULAR enum value from the response property for the response status

    • info

      removed the SIGN_ON_BONUS enum value from the response property for the response status

    • info

      removed the TERMINATION enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API