Logo
2cloudnine Payroll API API Documentation

2cloudnine Payroll API Collection

Number of APIs: 93


1. Auth - SOAP Login

POST {{url}}/services/Soap/u/{{version}}

Logs in to the login server and starts a client session.

Make sure to set the url, username, password and secretToken environment variables before sending this request. On success, the request will automatically collect your authentication token for later use.



2. Auth - Refresh Token

POST {{url}}/services/oauth2/token



3. Auth - JWT Bearer Token Flow

POST https://login.salesforce.com/services/oauth2/token

JWT Auth



4. Auth - Web Server Flow 1

GET {{url}}/services/oauth2/authorize?response_type=code&client_id={{clientId}}&redirect_uri={{redirectUrl}}&scope=full refresh_token



5. Auth - Revoke Token

POST {{url}}/services/oauth2/revoke



6. Auth - User Info

GET {{url}}/services/oauth2/userinfo



7. Auth - List Available REST API Versions

GET {{url}}/services/data/



8. REST-Objects-Assignment - Assignment Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



9. REST-Objects-Assignment - Assignment Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



10. REST-Objects-Assignment - Assignment Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



11. REST-Objects-Assignment - Assignment Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



12. REST-Objects-Assignment - Assignment By External Id

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



13. REST-Objects-Assignment - Assignment Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



14. REST-Objects-Assignment - Assignment Composite

POST {{url}}/services/data/v{{version}}/composite/



15. REST-Objects-Assignment Rate - Assignment Rate Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



16. REST-Objects-Client - Client Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



17. REST-Objects-Client - Client Invoice Entity Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



18. REST-Objects-Client - Client Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



19. REST-Objects-Client - Client by External ID

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



20. REST-Objects-Client - Client Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



21. REST-Objects-Client - Client Composite

POST {{url}}/services/data/v{{version}}/composite/



22. REST-Objects-Client Contact - Client Contact Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



23. REST-Objects-Client Contact - Client Contact Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



24. REST-Objects-Client Contact - Client Contact Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



25. REST-Objects-Client Contact - Client Contact Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



26. REST-Objects-Client Contact - Client Contact Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



27. REST-Objects-Client Contact - Client Contact by External ID

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



28. REST-Objects-Client Contact - Client Contact Composite

POST {{url}}/services/data/v{{version}}/composite/



29. REST-Objects-Employee - Employee Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



30. REST-Objects-Employee - Employee Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



31. REST-Objects-Employee - Employee Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



32. REST-Objects-Employee - Employee Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



33. REST-Objects-Employee - Employee Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



34. REST-Objects-Employee - Employee by External ID

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



35. REST-Objects-Employee - Employee Composite

POST {{url}}/services/data/v{{version}}/composite/



36. REST-Objects-File - Get Version Data

GET {{url}}/services/data/v57.0/sobjects/ContentVersion/0688c00000ELCjQAAX

Returns the ContentVersion metadata



37. REST-Objects-File - Get Version Data Binary File

GET {{url}}/services/data/v57.0/sobjects/ContentVersion/0688c00000ELCjQAAX/VersionData

Returns the binary data for the PDF which needs to be converted once sent to the desired destination.



38. REST-Objects-Payee - Payee Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



39. REST-Objects-Payee - Payee Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



40. REST-Objects-Payee - Payee Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



41. REST-Objects-Payee - Payee Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



42. REST-Objects-Payee - Payee Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



43. REST-Objects-Payee - Payee By External Id

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



44. REST-Objects-Payee - Payee Composite

POST {{url}}/services/data/v{{version}}/composite/



45. REST-Objects-Timesheet - Timesheet Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



46. REST-Objects-Timesheet - Timesheet Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



47. REST-Objects-Timesheet - Timesheet Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



48. REST-Objects-Timesheet - Timesheet Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



49. REST-Objects-Timesheet - Timesheet Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



50. REST-Objects-Timesheet - Timesheet By External Id

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



51. REST-Objects-Timesheet - Timesheet Composite

POST {{url}}/services/data/v{{version}}/composite/



52. REST-Objects-Timesheet Entries - Timesheet Entries Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



53. REST-Objects-Timesheet Entries - Timesheet Entries Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



54. REST-Objects-Timesheet Entries - Timesheet Entries Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



55. REST-Objects-Timesheet Entries - Timesheet Entries Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



56. REST-Objects-Timesheet Entries - Timesheet Entries Composite

POST {{url}}/services/data/v{{version}}/composite/



57. REST-Objects-# Timesheet Items - Timesheet Item Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



58. REST-Objects-# Timesheet Items - Timesheet Item Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



59. REST-Objects-# Timesheet Items - Timesheet Item Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



60. REST-Objects-# Timesheet Items - Timesheet Item Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



61. REST-Objects-# Timesheet Items - Timesheet Item Composite

POST {{url}}/services/data/v{{version}}/composite/



62. REST-Objects-Invoice - Invoice Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



63. REST-Objects-Invoice - Invoice Composite With VersionDataId

POST {{url}}/services/data/v{{version}}/composite/

VersionDataId is required to pass to the request 'Get Version Data Binary" which returns the content of the pdf in binary form



64. REST-Objects-Invoice - Invoice Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



65. REST-Objects-Invoice Items - Invoice Items

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



66. REST-Objects-Invoice Items - Invoice Items Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



67. REST-Objects-Interpretation Rule - Interpretation Rule Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


68. REST-Objects-Invoice Setting - Invoice Setting Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


69. REST-Objects-Invoice Schedule - Invoice Schedule Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


70. REST-Objects-Pay Advice - Pay Advice Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


71. REST-Objects-Pay Advice Line - Pay Advice Line Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


72. REST-Objects-Pay Schedule - Client Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


73. REST-Objects-Pay Transactions - Pay Transaction Insert

POST {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME



74. REST-Objects-Pay Transactions - Pay Transaction Update

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



75. REST-Objects-Pay Transactions - Pay Transaction Retrieve

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



76. REST-Objects-Pay Transactions - Pay Transaction Delete

DELETE {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



77. REST-Objects-Pay Transactions - Pay Transaction Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



78. REST-Objects-Invoice Tax ID - Invoice Tax ID Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


79. REST-Objects-Record Type - GET All Client Record Types

GET {{url}}/services/data/v{{version}}/query/?q=select+id,name+from+recordtype+where+SobjectType='account'+order+by+name+asc

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



80. REST-Objects-Location - Location Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


81. REST-Objects-Pay Advice Template - Pay Advice Template Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


82. REST-Objects-Leave Template - Leave Template Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


83. REST-Objects-Timesheet Calendar - Timesheet Calendar Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


84. REST-Objects-Timesheet Entry - Timesheet Entry Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


85. REST-Objects-Invoice Calendar - Invoice Calendar Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


86. REST-Objects-Payroll Calendar - Payroll Calendar Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


87. REST-Objects-Public Holiday Calendar - Public Holiday Calendar Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


88. REST-Objects-Pay Code - Pay Code Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


89. REST-Objects-Project Code - Project Code Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


90. REST-Objects-Payment Terms - Payment Terms Upsert

PATCH {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:EXTERNAL_ID_FIELD/:EXTERNAL_ID

  • Insert: Use the POST request to create a new client.
  • Upsert: Use the PUT request to create a new client or update an existing one.
  • Update: Use the PATCH request to update an existing client.
  • Retrieve: Use the GET request to retrieve information about a specific client.
  • Delete: Use the DELETE request to delete a client.


91. REST-Objects-Payment Terms - Payment Terms by External ID

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



92. REST-Objects-User - Get User

GET {{url}}/services/data/v{{version}}/query/?q=select+id+from+user+where+name+like+%27%25administrator%27

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.



93. REST-Objects-Superannuation - Superannuation Funds

GET {{url}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created. If a record does exist with that value, the field values specified in the request body are updated. If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST



ENDPOINTS