Annual / Hourly Gross Salary Retrieval via Sandbox API

Q&A
1

How can I retrieve the annual gross salary (or base salary) for a global_payroll contract in the sandbox environment via the sandbox API? I am trying to run some testing for a script to call the API and match a personal email in a separate sheet to Deel and pull in the hourly gross salary or annual gross salary. These are missing from the response I am receiving

2

Hi @sim_singh

To retrieve the annual gross salary for a Global Payroll contract, you can use the GET /people endpoint. The salary information is available under the payment object in the response.

Here’s an example of what you’ll see in the API response:

"payment": {
  "rate": 80000,
  "scale": "annual",
  "contract_name": "John Doe - Software Engineer",
  "currency": "AUD"
}
3

Hi @Ashot_Deel thank you for your response. This is great for my sandbox.

Now for my live workspace (non sandbox) we don’t have global payroll setup but I want to get “Hourly gross salary” which I can see on the contract object in the compensation section. Is there a specific endpoint you can guide me to there so I can read this information? Thanks!