classifications

Archive an employee

Archive an existing employee. In the response, the archived field is set as true.

post/v3/classifications/employees/{id}/archive

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/classifications/employees/{id}/archive
  • Auth
    none declared

Path parameters

idstring required

BILL-generated ID of the employee. The value begins with emp.

Example:{{employee_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Archive an employee response

idstring

BILL-generated ID of the employee. The value begins with emp.

firstNamestring

Employee first name

lastNamestring

Employee last name

shortNamestring

Employee short name

parentIdstring

BILL-generated ID of the parent employee. You can set this field if this employee is a child object.

archivedboolean

Set as true if the employee is archived

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

Changes

No recorded changes to this operation across all 2 revisions of this API.