Ceipal

StartFragment

Welcome to CEIPAL API. CEIPAL v1 API allows the customers to extract the data from their account to build any customized solutions as needed.

Rate limiting of the API is based on user authentication token and this is applicable to all authenticated endpoints. Once the rate limit is reached all the endpoints would return 400 error code.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

We have introduced new endpoints and made significant changes to the existing endpoints. Now all the endpoints are using the encrypted ids to enhance the data security. Please reach out to your CEIPAL account representative for more details as how to generate the API credentials to start using the endpoints.

  
EndFragment

Ceipal Workforce v1 API Reference

Authentication

Refresh Token

Get Employees List

Get Employee Details

Get Projects List

Get Project Details

Get Placement Lists

Get Placements Details

Get Timesheets List

Get Expenses List

Get Expense Details

Get Invoices

Get Invoice Details

Get Clients List

Get Client Details

Get Vendors List

Get Vendor Details

Get ESS Tickets

Get ESS Details

getCountriesList

getStatesList

Default

Production

Sandbox

CEIPAL API uses the combination of the User Name, Password and API Key to validate with the client's account to generate the Bearer Token. All the endpoints will be using this Bearer Token to access the data.Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys and it is advisable to rotate the API Key frequently for any misuse.All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

CEIPAL API uses the combination of the User Name, Password and API Key to validate with the client's account to generate the Bearer Token. All the endpoints will be using this Bearer Token to access the data.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys and it is advisable to rotate the API Key frequently for any misuse.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Email id configured in the Workforce Application setup for the API Access

email

Password configured in the Workforce Application setup for the API Access

password

API Key in the Workforce Application setup for the API Access

api_key

Pass 1 for the output to be in JSON format, pass 0 for the output format to be in XML, by default the output will be in XML format

json

access_token

refresh_token

_declaration

root

When the email or password entered is different from the email configured in the API access configuration

When the Required parameters are missing in the request

Authentication token is valid for 24 hours and to continue using the API, a new auth token needs to be generated. Use the refresh token to generate the new auth token and the refresh token is valid for 7 days.Send the access token in the headers as Token to get the new access token.

Authentication token is valid for 24 hours

 and to continue using the API, a new auth token needs to be generated. Use the refresh token to generate the new auth token and the refresh token is valid for 7 days.

Send the access token in the headers as Token to get the new access token.

token

This API will allows users to retrieve a list of all employees within a workforce management system. This API enables users to access key information about employees, such as their names, positions, and contact details. By utilizing this section, users can efficiently gather and analyze data on their workforce.

This API will allows users to retrieve a list of all employees within a workforce management system. This API enables users to access key information about employees, such as their names, positions, and contact details. By utilizing this section, users can efficiently gather and analyze data on their workforce.

Used as a header parameter to authenticate the request for accessing employee data.

Authorization

A query parameter used to specify the field by which the list of employees should be sorted.  Pass "employee_number" 

sortby

A query parameter used to specify the sorting order (ascending or descending) of the list of employees. Pass "asc" for ascending order and "desc" for descending order. for

sortorder

A query parameter used to specify the maximum number of employees to be returned in the response per page.

limit

Optional Parameter to get the records created/modified on or after the date. Date should be in yyyy-mm-dd format

modifiedOnOrAfter

Optional Parameter to get the records created/modified on or before the date. Date should be in yyyy-mm-dd format

modifiedOnOrBefore

count

num_pages

page_number

page_count

host

results

Pass the Employee ID in the URL to retrieve detailed information about employees. With this API, users can access employee data such as their profiles, work history, and contact information.

Pass the Employee ID in the URL to retrieve detailed information about employees. With this API, users can access employee data such as their profiles, work history, and contact information.

This header parameter is used to authenticate the request and must contain a valid access token. It authorizes the client to access the endpoint and retrieve employee details.

Use the Id parameter from the employee list to get the details of employee

employee_id

employeeDetails

This API will allows users to retrieve a list of all projects within a workforce management system. This API enables users to access key information about projects. By utilizing this section, users can efficiently gather and analyze data on their workforce.

This API will allows users to retrieve a list of all projects within a workforce management system. This API enables users to access key information about projects. By utilizing this section, users can efficiently gather and analyze data on their workforce.

A security token used to authenticate the API request and ensure the user has the necessary permissions to access the projects.

Specifies the field to sort the list of projects by. Valid options include project_id, project_name, start_date, end_date.

Determines the order in which the projects are sorted. Options are 'asc' for ascending order and 'desc' for descending order.

Limits the number of projects returned in the response. Must be a positive integer value.

Optional Parameter to get the records created/modified on or after the date. Date should be in yyyy-mm-dd format.

Optional Parameter to get the records created/modified on or before the date. Date should be in yyyy-mm-dd format.

Pass the Project ID in the URL to retrieve detailed information about Project. With this API, users can access project data such as their budget, invoicing information, and other details.

Pass the Project ID in the URL to retrieve detailed information about Project. With this API, users can access project data such as their budget, invoicing information, and other details.

The Authorization header parameter is used to authenticate the API request. It typically contains the access token or API key required to access the project details.

Provide the Project's primary id to get the project details

project_id

project_code

project_name

description

client

pricing_type

budget_amount

status

from_date

to_date

invoice_frequency

invoice_start_day

po_number

po_attachment

po_attachment_original

include_po_number

invoice_to_notifiers

invoice_cc_notifiers

invoice_bcc_notifiers

include_email_from_client

created

invoice_billing_address

invoice_type

invoice_product_item_income_account

invoice_product_item_category

invoice_start_date

invoice_point_of_contact_name

sow_id

client_code

currency

budgetdetails

invoiceschedules

placements

This API will allows users to retrieve a list of all placements within a workforce management system. This API enables users to access key information about placements, users can efficiently gather and analyze data on their workforce.

This API will allows users to retrieve a list of all placements within a workforce management system. This API enables users to access key information about placements, users can efficiently gather and analyze data on their workforce.

This header parameter contains the access token used for authentication and authorization purposes. It is required for accessing the endpoint securely.

Specifies the field by which the placement list should be sorted. Options include 'name', 'date', 'status', etc.

Indicates the sort order of the placement list. Values can be 'asc' for ascending or 'desc' for descending.

Sets the maximum number of placements to return in the response. Use this parameter to control pagination.

The getPlacementsDetails section of the Workforce Open APIs V1 allows users to retrieve detailed information about placements within the workforce platform. All the details entered in the placement will be available in the API, the Client Layers, Payment details, Recruitment team details, Work Locations, Costs/Overheads, Commissions, Invoice configurations, Timesheet configurations, and others.

The getPlacementsDetails section of the Workforce Open APIs V1 allows users to retrieve detailed information about placements within the workforce platform. All the details entered in the placement will be available in the API, the Client Layers, Payment details, Recruitment team details, Work Locations, Costs/Overheads, Commissions, Invoice configurations, Timesheet configurations, and others.

The Authorization header parameter is used to authenticate the API request, providing the necessary credentials to access the specified endpoint. It typically includes the authentication token or key required for secure communication between the client and the server.

Use the Id parameter from the employee list to get the details of placements

placement_id

job_id

job_code

job_title

emp_id

placement_title

client_id

job_start_date

job_end_date

projected_end_date

job_status

cost_center

domain

industry

project_type

charge_code

job_termination_notice

comments

supplier_id

inhouse_job

job_inactive_reason

purchase_order_id

net_payment_terms

payment_revision

ts_section_defaulter_notifiers

include_ts_section_defaulter_notifiers

workloc_state

workloc_country

timesheet_details

invoice_details

work_location

reporting_manager

clientDetails

vendorDetails

end_client_name

custom_labels

emp_email_id

emp_code

emp_name

emp_type

workloc_state_id

workloc_country_id

expenseDetails

statusReportDetails

employee

client_name

vendor_name

vendor_number

costs

commissions

netAmountDetails

recruitmentDetails

sow_name

To get the Timesheet details in the selected period or based on modifications. This feature provides valuable insights into workforce management and facilitates tracking of hours worked within a specified period.

To get the Timesheet details in the selected period or based on modifications. This feature provides valuable insights into workforce management and facilitates tracking of hours worked within a specified period.

The authentication token to access the API. Must be included in the header of the request.

The start date of the time range for which timesheets are being retrieved. Format: YYYY-MM-DD.

fromdate

The end date of the time range for which timesheets are being retrieved. Format: YYYY-MM-DD.

todate

The unique identifier for the employee for which timesheets are being retrieved.

The unique identifier for the placement of the workforce for which timesheets are being retrieved.

The maximum number of timesheets to be returned in the response. Default limit is set to 25.

Optional Parameter to get the records created/modified on or after the date. Date should be in yyyy-mm-dd format. fromdate and todate will not be considered if this parameter is provided in URL

Optional Parameter to get the records created/modified on or before the date. Date should be in yyyy-mm-dd format, fromdate and todate will not be considered if this parameter is provided in URL

Get the list of expenses submitted during the selected period (between from date and to date). Pass the status to get the Expenses in particular status.

Get the list of expenses submitted during the selected period (between from date and to date). Pass the status to get the Expenses in particular status.

Sections