Operation Definitions

Summary

This endpoint is used to create a single employee along with all related information, except employee jobs, in one request.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com
/External/General/Employee' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--data-raw '{
    "Firstname": "Jack",
    "Lastname": "Doe",
    "Name": "Jack Doe",
    "Username": null,
    "EmployeeCorporateCode": "8796276",
    "ExternalEmployeeId": "80",
    "PrimarySiteId": "63da4653b5c13514ecaeac0f",
    "Source": "TestSource",
    "EmployeePhones": [
        {
            "PhoneNumber": "+2-312-312-3123",
            "PhoneTypeCode": "HOME"
        }
    ],
    "EmployeeAddresses": [
        {
            "AddressTypeCode": "HOME",
            "Address1": "Address 1",
            "City": "Pittsburgh",
            "StateCode": "PA",
            "PostalCode": "15106",
            "CountryCode": "US"
        }
    ],
    "EmployeeContacts": [
        {
            "Firstname": "Jenny",
            "Lastname": "Doe",
            "CountryCode": "US",
            "Phone1": "+0-232-123-1231"
        }
    ],
    "EmployeeEmails": [
        {
            "Email": "836@com.com",
            "EmailTypeCode": "PRSNL"
        },
        {
            "Email": "837@com.com",
            "EmailTypeCode": "WORK"
        }
    ],
    "EmployeeSiteStatuses": [
        {
            "EffectiveDate": "2025-07-01",
            "StatusCode": "ACTV",
            "SiteIds": [
                "63df82df32753797d3cfa2e1",
                "63df82df32753797d3cfa2e2",
                "63da4653b5c13514ecaeac0f"
            ]
        }
    ],
    "PosCredentials": [
        {
            "EmployeePosCode": "12",
            "Password": "12",
            "RoleId": "63da469cb5c13514ecaeac10"
        }
    ]
}'

Responses

Summary

This endpoint allows the creation of one or multiple employee job records for a single employee, identified by the unique identifier (UID) provided in the URL.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com
/External/General/Employee/62fa6c4e66507a2370954f50/Jobs' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'Content-Type: application/json' \
--data '[
    {
        "JobCodeId": "58e63c06fbf17de5ced22064",
        "IsPrimaryJob": true,
        "CompensationTypeCode": "HOUR",  
        "SiteIds": ["63da4653b5c13514ecaeac0f","65fae456a881c84356c79d0a",
"64c228f421a5403fe5773bbf","67eb8df9f6ebe838aec61fd6"],
        "EmployeeJobPays": [
            {
                "EffectiveDate": "2025-01-01",
                "Rate": 15.56
            },
            {
                "EffectiveDate": "2024-01-01",
                "Rate": 14
            }
        ]
    },
    {
        "ExternalJobCodeId": "9087",
        "IsPrimaryJob": false,
        "CompensationTypeCode": "SLRY",  
        "SiteIds": ["63da4653b5c13514ecaeac0f",
"65fae456a881c84356c79d0a"],
        "EmployeeJobPays": [
            {
                "EffectiveDate": "2023-01-01",
                "Rate": 20000
            },
            {
                "EffectiveDate": "2026-01-01",
                "Rate": 20000
            }
        ]
    }
]'

Responses

Summary

This endpoint provides an ability to update only selected fields of the specific employee, whose unique identifier (UID) is provided in the URL, as well as updates to the child entities, with the ability to create new records.

Request Parameters

Sample Request Body

curl --location --request PATCH 'https://qa-backoffice-api.xenial.com
/External/General/Employee/6835ee484168f481249e8766' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--data-raw '{
    "Lastname": "Doe Jr.",
    "ExternalEmployeeId": "809",
    "EmployeeEmails": [
        {
            "Email": "837@email.com",
            "EmailTypeCode": "PRSNL"
        }
    ],
    "EmployeeSiteStatuses": [
        {
            "EffectiveDate": "2025-08-01",
            "StatusCode": "TERM",
            "SiteIds": [
                "63df82df32753797d3cfa2e1",
                "63df82df32753797d3cfa2e2",
                "63da4653b5c13514ecaeac0f"
            ]
        }
    ],
    "PosCredentials": [
        {
            "Password": "14"
        }
    ]
}'

Summary

This endpoint provides an ability to deactivate any existing, non-deleted job, as well as update its rates. If any other job fields should be updated because they were previously provided with incorrect values, such jobs should be deactivated and recreated.

Request Parameters

Sample Request Body

curl --location --request PATCH 'https://qa-backoffice-api.xenial.com
/External/General/Employee/Job/63da4ba2614bb6862d37a761' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--data '{
    "Deactivated": true,
    "DeactivationDate": "2025-05-01",
    "EmployeeJobPays": [
        {
            "EffectiveDate": "2025-02-01",
            "Rate": 12.75
        },
        {
            "EffectiveDate": "2024-01-01",
            "Rate": 15
        }
    ]
}'

Responses

Summary

This endpoint allows soft-deleting of an existing, non-deleted employee address record identified by the provided AddressTypeCode.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com
/External/General/Employee/6835ee484168f481249e8766/Address/HOME' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint allows soft-deleting of an existing, non-deleted employee phone record identified by the provided PhoneTypeCode.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com
/External/General/Employee/6835ee484168f481249e8766/Phone/home' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint allows soft-deleting of an existing, non-deleted employee email record identified by the provided EmailTypeCode.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com
/External/General/Employee/6835ee484168f481249e8766/Email/PRSNL' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint allows soft-deleting of an existing, non-deleted employee contact record identified by the provided ContactCode.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com
/External/General/Employee/6835ee484168f481249e8766/Contact/johndoe' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint allows soft-deleting of an existing, non-deleted employee job record identified by the provided [ID], together with all its existing non-deleted rates.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com
/External/General/Employee/
63da4601b5c13514ecaeac0d/Job/6835ee484168f481249e8766' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'Content-Type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint provides information about all payroll details created/updated/deleted in the database for a specified time frame received in the request and it provides information for both active and deleted payrolls.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com
/External/General/Payroll/GetUpdates?UpdateDateFrom=2023-08-08T23:50:00.000Z' \
--header 'Content-Type: application/json' \
--header 'X-Company-id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 620c011778da1c0008db8bac' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ....'

Responses

For a successful response:

{
    "Data": [],
    "NextUpdateDateFrom": 
"2025-03-21T05:25:18.000Z"
}

Summary

This endpoint returns a list of available ethnicities from Data Management - Ethnicities section.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com
/Lookup/Ethnicity' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...'

Responses

Summary

The GET Company Roles endpoint returns a list of available roles within a given company, which are configurable by end users. These role values are referenced when creating point of sale (POS) credentials for a given employee.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Auth
/GetCompanyRoles' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtp
ZCI6InhwcnQifQ...'

Responses

Summary

The GET Compensation Type endpoint returns a list of available compensation types from Data Management, which are not displayed on the user interface (UI).

Request Parameters

Request Sample Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup
/CompensationType' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtp
ZCI6InhwcnQifQ....'

Responses

Summary

The GET Employee Status endpoint returns a list of available Status records from Data Management -Employee Status Config section, which are assigned to Employees within Employee Site Status related requests.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup
/EmployeeStatus' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 63da4653b5c13514ecaeac0f' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtp
ZCI6InhwcnQifQ....'

Responses

Summary

The Get All Jobs operation returns an array of all of the jobs that an employee can be assigned to.

Request Parameters

Responses

Summary

The Add Employee operation creates a new employee record on our platform.

Request Parameters

Responses

Summary

The Get All Work Types operation returns a list of the kinds of work that an employee clocks in and out of during a shift.

Request Parameters

Responses

Summary

A punch record tracks an employees clock in and clock out actions over the course of a shift. Create a punch record for each shift and update it as the shift progresses.

Request Parameters

Responses

Summary

This endpoint works with one employee record only. Use this endpoint to create employee data for a single employee, including Employee Site Statuses and POS Credentials. For more information, see Create an Employee Record.

Request Parameters

Responses

Summary

Use the Request Employee Data endpoint to receive data for all previously created employees. This is useful when updating employee records.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Staff
/Employee/EmployeeDetail?code=8796282' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtp
ZCI6InhwcnQifQ.'

Responses

Summary

Used to create, update, or delete employee site status information in bulk. For more information, see Site Status Bulk Update.

Request Parameters

Responses

Summary

Used to create and update employee job data together with a corresponding employee’s rate information. It allows multiple job updates in one request. For more information, see Update All Employee Jobs.

Request Parameters

Responses

Summary

This endpoint updates employee data, including Employee Site Statuses and POS Credentials.

Request Parameters

Summary

Provides the ability to create one employee address at a time. This operation does not allow several addresses to be used for the same employee with the same Address Type.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeAddress' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "AddressTypeId": "58f4eb1b736c128b640d5845",
    "Address1": "9404 Bald Hill LaneBrooklyn",
    "Address2": "",
    "Address3": "",
    "City": "New York",
    "StateId": "58f51657736c128b640d5876",
    "PostalCode": "11228",
    "CountryId": "58f4f1ff736c128b640d584b",
    "Source": "ExtBackOffice"
}'

Responses

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup/
AddressType' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 61939a5901181700091be07a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….'

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup/
State' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 61939a5901181700091be07a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….'

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup/
Country' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 61939a5901181700091be07a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….'

Summary

Provides the ability to update one employee address at a time. This operation does not allow several addresses to be used for the same employee with the same Address Type.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeAddress endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request PUT 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeAddress/66d07bec0c1d271eb8232842' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "EmployeeAddressId": "66d07bec0c1d271eb8232842",
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "AddressTypeId": "58f4eb1b736c128b640d5845",
    "Address1": "9405 Bald Hill LaneBrooklyn",
    "Address2": "",
    "Address3": "",
    "City": "New York",
    "StateId": "58f51657736c128b640d5876",
    "PostalCode": "11228",
    "CountryId": "58f4f1ff736c128b640d584b"
}'

Responses

Summary

Provides the ability to delete one employee address at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeAddress endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeAddress/66d07bec0c1d271eb8232842' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'Content-Type: application/json'

Responses

Summary

Provides the ability to create one employee email record at a time.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeEmail' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Email": "email@gmail.com",
    "EmailTypeId": "58f7713ab8e30b8e5bbbc9b0",
    "Source": "ExtBackOffice"
}'

Responses

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup/
EmailType' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 61939a5901181700091be07a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….'

Summary

Provides the ability to update one employee email record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeEmail endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request PUT 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeEmail/66d0866d0c1d271eb8232877' \
--header 'authorization: 
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeeEmailId": "66d0866d0c1d271eb8232877",
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Email": "email2@gmail.com",
    "EmailTypeId": "58f7713ab8e30b8e5bbbc9b0",
    "Source": "ExtBackOffice"
}'

Responses

Summary

Provides the ability to delete one employee email record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeEmail endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeEmail/66d0866d0c1d271eb8232877' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

Provides the ability to create one employee phone record at a time.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com/Staff/
EmployeePhone' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "PhoneNumber": "+2-131-231-2312",
    "PhoneTypeId": "58f6653921eb68fc1f1b8d25",
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Source": "ExtBackOffice"
}'

Responses

curl --location --request GET 'https://qa-backoffice-api.xenial.com/Lookup/
PhoneType' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 61939a5901181700091be07a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ….'

Summary

Provides the ability to update one employee phone record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeePhone endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request PUT 'https://qa-backoffice-api.xenial.com/Staff/
EmployeePhone/66d08af60c1d271eb8232879' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeePhoneId": "66d08af60c1d271eb8232879",
    "PhoneNumber": "2131231231432",
    "PhoneTypeId": "58f6653921eb68fc1f1b8d25",
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Source": "ExtBackOffice"
}'

Responses

Summary

Provides the ability to delete one employee phone record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeePhone endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com/Staff/
EmployeePhone/66d08af60c1d271eb8232879' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

Provides the ability to create one employee contact record at a time.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeContact' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Firstname": "Cortney",
    "City": "New York",
    "PostalCode": "1313213",
    "CountryId": "58f4f1ff736c128b640d584b",
    "Phone1": "+3-434-545-3443",
    "Source": "ExtBackOffice"
}'

Responses

Summary

Provides the ability to update one employee contact record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeContact endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request PUT 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeContact/66d0938c957f64e8baba32e8' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f' \
--data-raw '{
    "EmployeeContactId": "66d0938c957f64e8baba32e8",
    "EmployeeId": "65c24fdaa007ddc53e65021f",
    "Firstname": "Cortney",
    "Lastname": "Dikson",
    "City": "New York",
    "PostalCode": "1313213",
    "CountryId": "58f4f1ff736c128b640d584b",
    "Phone1": "+3-434-545-3443",
    "Source": "ExtBackOffice"
}'

Responses

Summary

Provides the ability to delete one employee contact record at a time.

The ID is the unique identifier in our system of the employee contact record that should be updated. This field is returned in response to the POST /Staff/EmployeeContact endpoint or in response to the GET Staff/Employee/EmployeeDetail.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-backoffice-api.xenial.com/Staff/
EmployeeContact/66d0938c957f64e8baba32e8' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ…' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a'

Responses

Summary

This endpoint returns a list of available rate ranges for specific Job Code records and defined compensation types (Hourly, Salary) from Data Management Job Code Rates section, which are assigned to employees within the Employee Job related requests.

Request Parameters

Sample Request Body

curl --location --request GET 
'https://qa-backoffice-api.xenial.com/Staff/JobCodeRate' \
--header 'authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--header 'content-type: application/json' \
--header 'x-company-id: 63da4601b5c13514ecaeac0a' \
--header 'x-site-ids: 63da4653b5c13514ecaeac0f'

Responses

Summary

This endpoint returns a list of available payment types from Data Management Payment Type section.

Request Parameters

Sample Request Body

curl --location --request GET 
'https://backoffice-api.xenial.com/Lookup/TenderType' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 5ddab0e3d93109001df6a76c' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...'

Responses

Summary

This endpoint returns a list of available currencies configured in the Portal in the Data Management Tender Currency section.

Request Parameters

Sample Request Body

curl --location --request GET 
'https://backoffice-api.xenial.com/Lookup/TenderCurrency' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 5ddab0e3d93109001df6a76c' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...'

Responses

Summary

Provides the ability to create one new shift at a time for non-deleted company, site, employee, and employee job.

Request Parameters

Sample Request Body

curl --location --request POST 
'https://qa-backoffice-api.xenial.com/External/General/Shift' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 620c011778da1c0008db8bac' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...' \
--data-raw '{
    "EmployeeId": "62dc040174630b7536f71a96",
    "ExternalJobCodeId": "75",
    "StartDateTime": "2023-08-07T18:56:49Z",
    "EndDateTime": null,
    "Source": "TestSource",
    "ActualUpdateDate": "2023-08-08T07:16:57.000Z",
    "Breaks": [
        {
            "BreakStartDateTime": "2023-08-07T22:39:26Z",
            "BreakEndDateTime": "2023-08-08T00:16:38Z",
            "BreakTypeCode": "MEAL",
            "IsPaidBreak": true
        },
        {
            "BreakStartDateTime": "2023-08-08T02:30:00Z",
            "BreakEndDateTime": "2023-08-08T02:35:00Z",
            "BreakTypeCode": "REST",
            "IsPaidBreak": false
        }
    ],
    "Tips": [
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "CREDIT",
            "TenderCurrencyCode": "USD",
            "Amount": 9.00
        },
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "CUSTOM",
            "TenderCurrencyCode": "USD",
            "Amount": 0.70
        },
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "DEBIT",
            "TenderCurrencyCode": "USD",
            "Amount": 7.75
        }
    ],
    "Sales": [
        {
            "TenderTypeCode": "CASH",
            "TenderCurrencyCode": "USD",
            "Amount": 224.63
        }
    ]
}'

Responses

Summary

Provides the ability to update one new shift at a time for non-deleted company, site, employee, and employee job.

Request Parameters

Sample Request Body

curl --location --request PUT 
'https://qa-backoffice-api.xenial.com/External/Generat/Shift/
5e46af81636dc9000ab1afc9' \
--header 'Content-Type: application/json' \
--header 'X-Company-Id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 620c011778da1c0008db8bac' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ....' \
--data-raw '{
    "StartDateTime": "2023-08-07T18:56:49Z",
    "EndDateTime": null,
    "Source": "TestSource",
    "ActualUpdateDate": "2023-08-08T07:16:57.000Z",
    "Breaks": [
        {
            "BreakStartDateTime": "2023-08-07T22:39:26Z",
            "BreakEndDateTime": "2023-08-08T00:16:38Z",
            "BreakTypeCode": "MEAL",
            "IsPaidBreak": true
        },
        {
            "BreakStartDateTime": "2023-08-08T02:30:00Z",
            "BreakEndDateTime": "2023-08-08T02:35:00Z",
            "BreakTypeCode": "REST",
            "IsPaidBreak": false
        }
    ],
    "Tips": [
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "CREDIT",
            "TenderCurrencyCode": "USD",
            "Amount": 9.00
        },
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "CUSTOM",
            "TenderCurrencyCode": "USD",
            "Amount": 0.70
        },
        {
            "TenderCategoryCode": "DTIP",
            "TenderTypeCode": "DEBIT",
            "TenderCurrencyCode": "USD",
            "Amount": 7.75
        }
    ],
    "Sales": [
        {
            "TenderTypeCode": "CASH",
            "TenderCurrencyCode": "USD",
            "Amount": 224.63
        }
    ]
}'

Responses

Summary

Provides the ability to receive a list of all shifts, active and deleted, updated in a defined period of time.

Request Parameters

Sample Request Body

curl --location --request GET 
'https://qa-backoffice-api.xenial.com/External/General/Shift/
GetUpdates?UpdateDateFrom=2023-08-08T23:50:00.000Z' \
--header 'Content-Type: application/json' \
--header 'X-Company-id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 620c011778da1c0008db8bac' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ....'

Responses

Summary

Provides the ability to receive a list of all shifts for a defined business date with additional filtering options.

Request Parameters

Sample Request Body

curl --location --request GET 
'https://qa-backoffice-api.xenial.com/External/General/Shift/
GetByBusinessDate?BusinessDate=2023-08-08&EmployeeIds=6690db6d636c0f9b657ce4cf,
6690db6d965c2ba2c74e471b&IncludeDeleted=true&ShiftStatuses=CLOCKED_OUT,
CLOCKED_IN&ItemsPerPage=50&PageNumber=2' \
--header 'Content-Type: application/json' \
--header 'X-Company-id: 63da4601b5c13514ecaeac0a' \
--header 'X-Site-Ids: 620c011778da1c0008db8bac' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ....'

Responses

Summary

Provides the ability to receive a list of shifts based on the received identifiers (IDs).

Request Parameters

Sample Request Body

curl --location --request GET 'https:
//qa-backoffice-api.xenial.com/External/General/Shift/
GetByShiftIds?ShiftIds=62a6b87bb4fd7c0008692cc5,
65a6d588adf7e83d16d43313,64d56a110745cc5992a0a1e0,
64d56a3421800bf5155221e1,62a3590cf118dc00098dfbc2,
62c2ed58dc684eeab137afa1,62a6ba9dde4ad10008787202,
6216c4a9300f510008713939,62bf0330c269a6b441b77410,
62c323603ec4efe48384366d,62a7688eec28df000852ca4e,
62c3247378d3983c50a26aaa,62efe194f24a76771990e9f7,
6303b0f116a947b559ad973b,630cdffcbada7f474bc32bc4,
62f167f2ac2319d201d3fea5,62bcb282c35cb31d0f3758b1,
6304223db5ce1b620f0c9d8a,62bb3a52bbba59d8728a30ec,
62bb3ad82f4d8129093e07d8,62fa91210b6d6caf565254b0,
62bf023724d1569abf8b65dd,630ce8816e9f5e8429b9e98a,
61e8540c61592400086ebe62,62bcb2f0c842bf57ad6d3e66,
62a769e990ec100009158ed3,63041f73d5c980d7a7188794,
632b5a73b3c158e7e98a99aa,653a8fcefc74f491eea4a785,
63ae19bc9bd59b8b2e074851,64dc427b31f797ced93bce37,
63222fe5b3c158e7e98a9986,63223091dda51a6ab003cd21,
640255a804d21164204471aa,63405118d977f30666a8e1ef,
634859cffd12eb7dc81647cc,638fd7bac4bc14f39d2b042d,
638fd8c509528134de27ba4a,638fd95288adf859c7bb43f8,
638fd8300cd618ba2208e7d9,63a61c5401e6f5aa67ad6fa2,
6401348cbf987c3ff11d3380,647e5ba17632754908569f8b,
64b2dd29a5819a837663636d,654a9e1c4d97db69ef8be611,
64d56ba45317fb67d6cfce2f,64c99dd8a490a4bf8d9927e5, \
--header 'Content-Type: application/json' \
--header 'X-Company-id: 63da4601b5c13514ecaeac0a' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ....'

Responses

Summary

Provides an ability to create only one active schedule and its child shifts at a time.

Request Parameters

Sample Request Body

curl --location --request POST 'https://qa-schedule.xenial.com/v2/schedules' \
--header 'x-company-id: 5ee35ad4653fed0009c8ff56' \
--header 'x-site-ids: 5ee35af39c0d910009207773' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]' \
--data-raw '{
    "StartDate": "2023-11-24T00:00:00.000Z",
    "EndDate": "2023-11-27T00:00:00.000Z",
    "Timezone": "US/Eastern",
    "Source": "New Schedule Test",
    "Shifts": [
        {
            "BusinessDate": "2023-11-24T",
            "StartTime": "2023-11-24T13:30:00.000Z",
            "EndTime": "2023-11-24T23:15:00.000Z",
            "EmployeeCorporateCode": "134489",
            "JobCodeId": "58e63c06fbf17de5ced22014"
        },
        {
            "BusinessDate": "2023-11-26",
            "StartTime": "2023-11-26T13:00:00.000Z",
            "EndTime": "2023-11-26T23:00:00.000Z",
            "EmployeeId": "607eab3dbffe7e00011adfd1",
            "ExternalJobCodeId": "80892",
            "ExternalShiftId": "920u93"
        }
    ]
}'

Responses

Summary

Provides an ability to update only one active schedule and its child shifts at a time.

Request Parameters

Sample Request Body

curl --location -g --request PUT 'https://qa-schedule.xenial.com/v2
/schedules/66d16bbafea8ff072f4181c6' \
--header 'x-company-id: 5ee35ad4653fed0009c8ff56' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]' \
--data-raw '{
    "StartDate": "2023-11-24T04:00:00.000Z",
    "EndDate": "2023-11-27T04:00:00.000Z",
    "ModifyTime": "2023-11-28T00:09:00.000Z",
    "Shifts": [
        {
            "ShiftId": "63da4601b5c13514ecaeac0a",
            "BusinessDate": "2023-11-24",
            "StartTime": "2023-11-24T13:00:00.000Z",
            "EndTime": "2023-11-24T23:00:00.000Z",
            "EmployeeCorporateCode": "134489",
            "JobCodeId": "58e63c06fbf17de5ced22014"
        },
        {
            "BusinessDate": "2023-11-26",
            "StartTime": "2023-11-26T13:00:00.000Z",
            "EndTime": "2023-11-26T23:00:00.000Z",
            "EmployeeId": "607eab3dbffe7e00011adfd1",
            "ExternalJobCodeId": "80892",
            "ExternalShiftId": "920u93"
        }
    ]
}'

Responses

Summary

Provides an ability to retrieve a list of all existing, non-deleted schedule records with a list of their non-deleted child shifts based on the received query filters.

Request Parameters

Sample Request Body

curl --location --request GET 'https://qa-schedule.xenial.com/SchedulesService
/schedules?$top=50&$skip=0&StartDate=2025-02-20' \
--header 'x-company-id: 67c17d6db633aac8decd6dca' \
--header 'x-site-ids: 67c18218c2cda380bb670597' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhwcnQifQ...'

Responses

Summary

This endpoint is used to soft-delete existing, non-deleted schedule’s shifts.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-schedule.xenial.com/v2/shifts
/66d16bba4cacd4f3472174a4' \
--header 'x-company-id: 60ddef56f5b0920007046a72' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]'

Responses

Summary

This endpoint is used to soft-delete existing, non-deleted schedules.

Request Parameters

Sample Request Body

curl --location --request DELETE 'https://qa-schedule.xenial.com/v2/schedules
/66d16bba4cacd4f3472174a4' \
--header 'x-company-id: 60ddef56f5b0920007046a72' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]'

Responses

Summary

This endpoint retrieves details of a single, active, non-deleted employee associated with the specified company. The response includes the complete employee information and, if requested, additional details such as addresses, site statuses, and other related data.

Request Parameters