What Is An API and What Is The e-manage|ONE API

An API, or Application Programming Interface, is a tool that programmers use to add new features to software without changing core features of the software system. With an API, you could build your own processes into e-manage|ONE without having to contact our team.

Getting Started

To start accessing data from the e-manage|ONE API, you’ll first need to grab an authentication token. An authentication token is like a passport that your application uses to gain access to our country, the e-manage|ONE data. Here’s a step-by-step guide that you can follow to start using our API to build your application.

Step 1: Get A Unique Application ID From Our Support Team

First, contact support@emanageone.com so that we can create an identifier for your application. We use this application identifier to track access to our customer’s database and protect our customer’s sensitive data.

If you’re just trying the API out and aren’t ready to get in touch, you can use `sandbox` as your application ID and continue onto the next step.

Step 2: Login

Next, you’ll need to create a request to receive an e-manage|ONE access token. Create an HTTP request with the following headers:

1. An e-manage user’s username
2. An e-manage user’s password with SHA256 encryption
3. A database connection string alias
4. An application ID for your application

If you’re just trying out the API and don’t have access to anyone’s e-manage|ONE credentials you can use the following credentials.

1. `SandboxUser` as the username
2. `4ce6e24cd4d606e0e864c25d5b0bf82adc6bdfaf4f442c6db5e9b9e392ef410c` as the password
3. ‘SandBox’ as the database connection string alias
4. `sandbox` as the application id

This is the request using the curl utility. You can execute this in your terminal or import it into Postman to get started.

curl --location --request POST 'https://emws.azurewebsites.net/api/login/' \
--header 'username: SandboxUser' \
--header 'password: 4ce6e24cd4d606e0e864c25d5b0bf82adc6bdfaf4f442c6db5e9b9e392ef410c' \
--header 'database: SandBox' \
--header 'client_id: sandbox'

Step 3: Using the login response to access resources.

Once you submit the login request, you will receive a response. The response is a JSON Web Token (JWT), it’s an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Here’s an example JWT

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

If you want to inspect the contents of the JWT that you’re receiving from our API, visit https://jwt.io/ to see what our decoded payload looks like.

Step 4: Accessing Resources

You’re almost there if you’ve gotten to this point! You’ll need to decode the JWT to create the headers of each request that you’re going to use to access e-manage|ONE’s database.

Quickstart

If you’re just exploring, and not ready to program, you can use this request to access any endpoint in the sandbox environment. This request returns the first 10 companies in the sandbox database.

curl --location 'https://emws.azurewebsites.net/api/companies/' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

Programming 

If you are at the programming stage, we’ll help you get started. First, choose a popular JWT library based on the programming language that you’re using for your application. You can find popular JWT libraries using this web page for your programming language: https://jwt.io/libraries

Step 1: use the JWT Library to decode the JWT payload that you received in the login response. 

Step 2: extract the ‘x-functions-key’ from the decoded JWT payload’s body and add it to your request header.

Step 3: Add the entire encoded JWT as the Authorization header with a value of Bearer <YOUR_JWT>.

Great! Now you’re ready to get started using the API. If you have any questions about how to use the API, please contact support@emanageone.com to get started.

The Data That’s Available For You

Once you have a valid access token, you’ll have access to create, read, update, and delete most objects in the database. Here’s the base url that you can use to get started:

https://emws.azurewebsites.net/api/

The Basics:

Each object that we expose through our APIs follows the same conventions. Let’s get started by understanding how to get projects:

Step 1: Query the /{resource_name} endpoint

First, query the /{resource_name} endpoint. By resource name, we mean e-manage objects like companies, contacts, projects, etc. Later in this article, we’ll give you a list of all the endpoints that are available for you, but for now let’s query the /companies endpoint first like so:

curl --location 'https://emws.azurewebsites.net/api/companies/' \
--header 'x-functions-key: hHcjMUZT1Aa3T2YT_hsF3HXn5uUm_s3IAmLEbDVwslBMAzFu5YP2Qw==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

Querying any endpoint that takes the /{resource_name} format, will return a list of those results. To see the details of only one resource, you can use the /{resource_name}/{id} endpoint. For example:

curl --location 'https://emws.azurewebsites.net/api/companies/2655' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

Pagination

By default, the API will include 10 results from the database and start from the 1st result. If you’d like more results from the database, add the limit query parameter like so:

curl --location 'https://emws.azurewebsites.net/api/companies/?limit=100' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

In a case where you need to start your results at somewhere other than the beginning, use the start parameter like so:

curl --location 'https://emws.azurewebsites.net/api/companies/?limit=100&start=10' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

Filtering

Lastly, let’s talk about filtering. Let’s say that you only want projects that are marked as a hotJob. In e-manage, hot jobs are set with the hotJob field equal to 1. So with our API, we tried to translate that query as closely as we could. To construct a query where you only get hotJobs, you’d use the following:

curl --location 'https://emws.azurewebsites.net/api/projects/?hotJob=1' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

In general, you can pick any attribute of the resource that you’re getting from our database, hotJob in this case, and filter results by values equal to the right hand side of the equation.

Complex Filters

Sometimes, it won’t be enough for a query to be filtered by fields that are strictly equal to a value, like in the hotJob example.

For example, if we want to filter a schedule on dates that are between the beginning of the month and end of the month, we’d need thousands of queries: one for 11/20/2023: 11:59:59, and another for  11/20/2023 11:50:58, and so on. As a solution, e-manage|ONE API uses left hand side (LHS) brackets so that you can filter using comparisons besides equals, let’s look at an example:

curl --location --globoff 'https://emws.azurewebsites.net/api/projectInstallationSchedule/?startDate[lte]=2017-11-20T00%3A00%3A00' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

In this example, we query the /projectInstallationSchedule endpoint and look for objects where the startDate is less than or equal to 11/20/2017, denoted by the [lte] bracket. In general, these complex filters will take the following format

{resource_name}/{property_name}[{operator}]={value}

Here are some examples

projects/?hotJob[eq]=1

projects/?createDate[gte]=2017-11-20T00:00:00

projects/?probabilityPercent[lte]=90.0

And a full list of operators and what they do

Operator Name	Description
[eq]	Compares the value supplied on the right hand side of the query expression to all values in the database using the equals (==) operator
[lt]	Compares the value supplied on the right hand side of the query expression to all values in the database using the less than (<) operator
[gt]	Compares the value supplied on the right hand side of the query expression to all values in the database using the greater than (>) operator
[lte]	Compares the value supplied on the right hand side of the query expression to all values in the database using the less than or equal to (<=) operator
[gte]	Compares the value supplied on the right hand side of the query expression to all values in the database using the greater than or equal to (>=) operator
[contains]	Compares the value supplied on the right hand side of the query expression to all values in the database using the contains

Putting It All Together

Congrats for making it this far! In conclusion, let’s recall what we’ve learned up until this point and come up with a complex query to solidify our understanding. 

The e-manage|ONE Api always uses pagination when returning results from the /resource endpoints. To start the page at a different offset, use the start query parameter. To specify the number of results that you would like to receive use the limit query parameter. If you would like to filter results by a resource’s attributes, you can use the attribute name with an operator, enclosed in LHS brackets.

Final example: Get all projects created after 20/11/2017, where the probability percent is equal to 90. The page of results should be offset by 20 results and the page’s size should contain 20 results.

curl --location --globoff 'https://emws.azurewebsites.net/api/projects/?createDate[gt]=2017-11-20T00%3A00%3A00&probabilityPercent[eq]=90.0&limit=20&start=20' \
--header 'x-functions-key: QOMf9g0lOajV74vys2UQq9w0hhENeOmFGVe32r54RsviAzFuaulk3w==' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlbXdzLmF6dXJld2Vic2l0ZXMubmV0Iiwic3ViIjoiMyIsImNsaWVudF9pZCI6InNhbmRib3giLCJjb25uZWN0aW9uLXN0cmluZyI6IlNlcnZlcj10Y3A6ZW1ub3J0aGNlbnRyYWwuZGF0YWJhc2Uud2luZG93cy5uZXQsMTQzMztJbml0aWFsIENhdGFsb2c9ZU1hbmFnZS1TYW5kQm94O1BlcnNpc3QgU2VjdXJpdHkgSW5mbz1GYWxzZTtVc2VyIElEPWVNYW5hZ2VTYW5kQm94O1Bhc3N3b3JkPWM9dWtpZyFtbHRyaTNlUHIkYnJhd3JhWUBwPTRDXHUwMDI2LVA1STJ1LVJVQztNdWx0aXBsZUFjdGl2ZVJlc3VsdFNldHM9RmFsc2U7RW5jcnlwdD1UcnVlO1RydXN0U2VydmVyQ2VydGlmaWNhdGU9RmFsc2U7Q29ubmVjdGlvbiBUaW1lb3V0PTMwOyIsIngtZnVuY3Rpb25zLWtleSI6IlQtNUJ5QkQwWWZDcGlPLXNleUZORG9XWW1oajZTdHJqN3kzVmc1SHJFV1JIQXpGdVRndVRTUT09IiwibmFtZSI6IlNhbmRib3hVc2VyIn0.YoiFzsNQmf_pM1SBIgxtHgVWVEdLI2OnmQkrLlcLk59TBFonlxmpZo9NXGw1pvWY-YGlhJhgrecPI9J943Zgw7Kon_5Pq7iDfHodyWOyCaA054ZuX2zpq8Ce5sgn5p2W3QZnE-00Qa1cHDT_w58vByMdtbOiipCOY9IWm2HosOCBf9KmnSg0-lrMRV6A_shmZWYo9x_qRx5qPNYD14YRLgAEFX210cax9TW4F3Y_yhr2TUOydBvuoQcpowcwUVpwwomj1mUAf31rTDCNC1faRJIhBRocpEcBm3bEpeWteSwy9pDrNX_K4IWj3Bqen7aWyG-IZv5FZSpr6t03qgyObqcpjRMUsTCMtanvLbTouC1dvmmlAETcTncDOP5XYuqh9_B0E0n62AiZQ8TCc54V2W2Yp9REh9RjaBmtevFZTZgZCDlRaKVyNeL7I6DOUZHF9sOSxuTuEySnl1fEjHBxlfK3JQjBvPxv4GZLkJ0lC1NW_TPWkAPzo5r22kT59CqqaTwN9a2m2gpg5xqf8AFMHraeCwnkfB1aba6e_bejUTy8-fa508tRlhln8KNGhURXVifDsTG5DtuV_f50C2w84Wuz1ti_BafFn-wA1KBQ0ept9gvmVniGI9PqyGp8rHuOXIBKZiS7mM6pGoCSp0kCiGtFGIK0KD5Xwr_glwZyNgo'

Full API Documentation

Projects

1. Endpoint: /projects/

Supported HTTP Methods

GET, PUT, POST, and DELETE requests are supported.

2. General Description

The /projects/ endpoint provides functionality to manage project information. A project in the context of this API represents a business project with various attributes such as project name, type, status, dates, and associated entities.

3. Attributes

Attribute	Type	Description
ProjectInstallationInstallerID	int	Unique identifier for the installer record
ProjectInstallationID	int	Identifier linking to the project installation
Installer	string (max length: 85)	Name of the installer
Installing	string (max length: 85)	Description of what the installer is installing
BillableServiceSchedule	string (max length: 85)	Service schedule for billing
PaySchedule	string (max length: 85)	Pay schedule for the installer
PayrollCreated	short	Indicator for payroll creation
Rating	string (max length: 85)	Rating assigned to the installer
RatingNotes	string (max length: 500)	Additional notes related to the rating
StartTime	datetime	Start time of the installer’s work
EndTime	datetime	End time of the installer’s work
Confirmed	short	Confirmation status of the installer’s work
TimeClockID	int	Identifier linking to the time clock record
TravelTime	decimal (18, 13)	Duration of travel time
TravelTimeStart	datetime	Start time of travel time
TravelTimeEnd	datetime	End time of travel time
TravelTimePaySchedule	string (max length: 85)	Pay schedule for travel time
OvertimePaySchedule	string (max length: 85)	Pay schedule for overtime
TravelTime2	decimal (18, 13)	Duration of additional travel time
TravelTime2Start	datetime	Start time of additional travel time
TravelTime2End	datetime	End time of additional travel time
LunchHour	double	Duration of lunch break
LunchTimeOut	datetime	Lunch break start time
LunchTimeIn	datetime	Lunch break end time
DoubleTimePaySchedule	string (max length: 85)	Pay schedule for double time

Project Documents

1. Endpoint: /projectdocuments/

Supported HTTP Methods

GET, PUT, POST, and DELETE requests are supported.

2. General Description

The /projectdocuments/ endpoint manages project document information. A project document in the context of this API represents a file associated with a specific project, including attributes such as document name, type, creation details, and content.

3. Attributes

Attribute	Type	Description
ProjectDocumentId	int	Unique identifier for the project document.
ProjectId	int	Identifier for the project associated with the document.
DocumentName	string	The name of the project document.
OriginalFileName	string	The original file name of the document.
DocumentType	string	Type or category of the document.
CurrentDocument	short	Indicator for the current version of the document.
CreateDate	DateTime	Date when the document was created.
CreatedBy	string	User or entity who created the document.
UserId	int	Identifier for the user associated with the document.
Pub	short	Indicator for public visibility of the document.
CustomerViewable	short	Indicator for customer visibility of the document.
Document	byte[]	Binary data representing the content of the document.
FileExtension	string	Extension of the document file.
Keywords	string	Keywords associated with the document.
ModifiedDate	DateTime?	Date when the document was last modified.
ModifiedBy	string	User or entity who last modified the document.
SecurityLevel	string	Security level associated with the document.
RetentionDate	DateTime?	Date when the document’s retention period expires.
Size	int?	Size of the document in bytes.
IsGalleryImage	short?	Indicator for whether the document is a gallery image.

Project Contacts

1. Endpoint: /projectcontacts/

Supported HTTP Methods

GET, PUT, POST, and DELETE requests are supported.

2. General Description

The /projectcontacts/ endpoint manages the association between projects and contacts in the EMWS application. It facilitates the storage of details related to contacts associated with specific projects. These details include information such as contact type, influence status, and email groups.

3. Attributes

Attribute	Type	Description
ProjectContactId	int	Unique identifier for the project contact.
ProjectId	int	Identifier for the project associated with the contact.
ContactId	int	Identifier for the contact associated with the project.
SalesLeadId	int?	Identifier for the sales lead associated with the contact.
BillToContact	short	Indicator for billing contact.
ShipToContact	short	Indicator for shipping contact.
ProjectContactType	string	Type or category of the project contact.
PrimaryContact	short?	Indicator for the primary contact.
InfluenceType	string	Type of influence associated with the contact.
InfluenceStatus	string	Status of influence associated with the contact.
EmailGroups	string	Groups or categories for email associated with the contact.
IsInstallationContact	int?	Indicator for installation contact.

Project Notes

1. Endpoint: /projectnotes/

Supported HTTP Methods

GET, PUT, POST, and DELETE requests are supported.

2. General Description

The /projectnotes/ endpoint manages notes associated with projects in the EMWS application. It provides functionality to store and retrieve details related to project notes, including information such as note type, content, and associated user details.

3. Attributes

Attribute	Type	Description
ProjectNoteId	int	Unique identifier for the project note.
ProjectId	int	Identifier for the project associated with the note.
UserId	int	Identifier for the user who created the note.
CreateDate	DateTime	Date and time when the note was created.
NoteType	string	Type or category of the project note.
Pub	short	Indicator for public visibility of the note.
Note	string	Content of the project note.
ProductType	string	Type of product associated with the note.
UseAsPopUp	bool?	Indicator for using the note as a popup.
PopUpOnChild	bool?	Indicator for displaying the popup on child elements.
ContactId	int?	Identifier for the contact associated with the note.
Mfgfeed	bool?	Indicator for manufacturing feed related to the note.

Companies

1. Endpoint: /companies/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The Companies class represents information about various companies in the system. Each instance of this class corresponds to a unique company entity with details such as company name, location, contact information, and various settings.

3. Attributes

Attribute	Type	Description
CompanyId	int	Unique identifier for the company.
CompanyName	string	Name of the company.
LocationName	string	Name of the location.
Address	string	Primary address of the company.
Address2	string	Additional address information.
ZipCodeId	int	Identifier for the ZIP code associated with the company.
ExtZip	string	Extended ZIP code information.
MainPhone	string	Main contact phone number.
MainFax	string	Main contact fax number.
CompanyType	string	Type or category of the company.
AllSalespeople	short	Indicator for all salespeople associated with the company.
SalesTerritory	string	Territory covered by the sales team.
ReferredBy	string	Source or entity that referred the company.
Status	string	Status or state of the company.
NumberOfEmployees	string	Number of employees in the company.
MarketType	string	Type of market the company operates in.
CreditAmount	decimal	Amount of credit associated with the company.
User1 to User4	string	Custom user-defined fields for additional information.
WebSite	string	Company’s website URL.
UserId	int?	Identifier for the user associated with the company.
CreateDate	DateTime	Date and time when the company record was created.
Deleted	short	Indicator for a deleted company record.
DeletionDate	DateTime?	Date and time when the company record was deleted.
OnCreditHold	short?	Indicator for credit hold status.
InstallationVendor	short?	Indicator for whether the company is an installation vendor.
Sic	string	Standard Industrial Classification code.
TaxExempt	short?	Indicator for tax-exempt status.
MailingAddress	string	Mailing address of the company.
MailingAddress2	string	Additional mailing address information.
MailingZipCodeId	int?	Identifier for the ZIP code associated with the mailing address.
UpdateId	string	Identifier for updates related to the company.
Expires	DateTime?	Date and time when the company record expires.
TaxCode	string	Tax code associated with the company.
AccountingId	string	Accounting identifier for the company.
UpdateUrl	string	URL for updates related to the company.
MbobjectId	int?	Identifier for the MbObject associated with the company.
DefaultBillToRemitTo	int?	Default bill-to and remit-to identifier.
DefaultBillToAttention	string	Default attention information for bill-to contacts.
QblistId	string	QuickBooks list identifier.
RegisteredAccount	short?	Indicator for a registered account.
DefaultTerms	string	Default payment terms for the company.
DefaultApaccount	int?	Default accounts payable account identifier.
DefaultMarkup	double?	Default markup associated with the company.
IsWarehouse	short?	Indicator for whether the company is a warehouse.
IsFurnitureDealer	short?	Indicator for whether the company is a furniture dealer.
IsArchitect	short?	Indicator for whether the company is an architect.
OldCompanyId	string	Identifier for the old company.
TollFree	string	Toll-free contact number for the company.
CustDisc	decimal?	Customer discount associated with the company.
DumpFee	decimal?	Fee associated with dumping.
OfdaenterpriseName	string	Name associated with OFDA enterprise.
OfdaenterpriseCode	string	Code associated with OFDA enterprise.
CorporateDivisionId	int?	Identifier for the corporate division associated with the company.
AllowOtherDivisions	short?	Indicator for allowing other divisions.
IsFarm	byte?	Indicator for whether the company is a farm.
Latitude	string	Latitude coordinates for the company location.
Longitude	string	Longitude coordinates for the company location.
MapId	string	Identifier for the map associated with the company.
MainPicture	byte[]	Main picture or logo associated with the company.
DefaultShipTo	int?	Default ship-to identifier.
DefaultStattention	string	Default attention information for ship-to contacts.
GroupContractId	int?	Identifier for the group contract associated with the company.
Ofdatype	string	Type associated with OFDA.
IsReference	short?	Indicator for whether the company is a reference.
CanVisit	short?	Indicator for whether the company can be visited.
ReferenceContact	string	Contact associated with the reference.
CrossStreets	string	Cross streets near the company location.
Neighborhood	string	Neighborhood associated with the company location.
SendsAcknowledgement	short?	Indicator for sending acknowledgments.
FederalTaxId	string	Federal tax identifier for the company.
ReportingMethod	string	Method used for reporting.
QbtaxCode	string	QuickBooks tax code.
QbtaxItem	string	QuickBooks tax item.
ResaleCertificate	string	Resale certificate associated with the company.
MarkForQbsync	short?	Indicator for marking the company for QuickBooks sync.
PosAreInternal	short	Indicator for internal purchase orders.
DefaultDeliverTo	int?	Default deliver-to identifier.
DefaultDeliverToAttention	string	Default attention information for deliver-to contacts.
SmallMainPicture	byte[]	Small version of the main picture associated with the company.
GstpsttemplateId	int?	GST/PST template identifier.
CreditHoldBy	string	User or entity responsible for placing the company on credit hold.
CreditHoldReason	string	Reason for placing the company on credit hold.
CreditHoldDate	DateTime?	Date and time when the credit hold was placed.
DefaultWipaccount	int?	Default work in progress (WIP) account identifier.
InvWarehouseId	int?	Inventory warehouse identifier.
WebCode	string	Code associated with the company for web purposes.
Ofdausername	string	Username associated with OFDA.
Ofdapassword	string	Password associated with OFDA.
OfdabillAccount	string	Bill account associated with OFDA.
OfdashipAccount	string	Ship account associated with OFDA.
ContractName	string	Name associated with contracts for the company.
BillName	string	Name associated with billing for the company.
OrderName	string	Name associated with orders for the company.
TransactionName	string	Name associated with transactions for the company.
OfdadealerOrderContact	string	Contact associated with dealer orders for OFDA.
OfdadeliveryApptContactId	int?	Identifier for the contact associated with OFDA delivery appointments.
OfdadeliverySiteContactId	int?	Identifier for the contact associated with OFDA delivery sites.
OfdashipServices	string	Ship services associated with OFDA.
OfdaendUserAccount	string	End-user account associated with OFDA.
OfdaendUserCompanyId	int?	Identifier for the end-user company associated with OFDA.
OfdaendUserContactId	int?	Identifier for the end-user contact associated with OFDA.
OfdadealerAccount	string	Dealer account associated with OFDA.
VendorCommissionSalesAccount	int?	Identifier for the sales account used for vendor commissions.
IsComshipTo	short?	Indicator for whether the company is a COM ship-to.
SchedulingEmail	string	Email address for scheduling purposes.
IsDirectBill	short?	Indicator for direct billing.
VendorCommission	double?	Commission percentage for vendors.
CommissionUseMargin	short?	Indicator for using margin for commission calculation.
DoesNotRequirePhysicalPo	short?	Indicator for not requiring a physical purchase order.
ChargesFreight	short?	Indicator for whether the company charges for freight.
CustomerLogo	byte[]	Logo associated with the customer.
QuoteTemplateId	int?	Identifier for the quote template associated with the company.
VerifiedCompanyName	string	Verified name of the company.
VerifiedAddress1	string	Verified address line 1.
VerifiedAddress2	string	Verified address line 2.
VerifiedCity	string	Verified city.
VerifiedState	string	Verified state.
VerifiedZipPlus4	string	Verified ZIP code plus 4.
LastVerificationDate	DateTime?	Date and time of the last verification.
VerificationCount	short?	Count of verifications.
VerificationReturnCode	int?	Return code of the last verification.
PoinvoiceGstpsttemplateId	int?	GST/PST template identifier for PO invoices.
PayableGstpsttemplateId	int?	GST/PST template identifier for payables.
FreightPartId	int?	Identifier for the part associated with freight.
ChangeVendor	short?	Indicator for changing the vendor.
AutoPartPhaseId	int?	Identifier for the auto part phase.
Qbcurrency	string	Currency code used in QuickBooks.
FreightCap	decimal?	Freight cap amount.
FreightCapUseCost	short?	Indicator for using cost in freight cap calculation.
FreightMinCharge	decimal?	Minimum charge for freight.
CalcFreightPerc	decimal?	Percentage used in calculating freight.
CalcFreightUseCost	short?	Indicator for using cost in calculating freight.
VendorWiptaxAccountId	short?	Identifier for the WIP tax account associated with vendors.
VendorNonWiptaxAccountId	short?	Identifier for the non-WIP tax account associated with vendors.
IsDumpSite	short?	Indicator for whether the company is a dump site.

Company Documents

1. Endpoint: /companydocuments/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The CompanyDocuments class represents documents associated with companies in the system. Each instance of this class corresponds to a unique company document, containing information such as document name, original file name, document type, creation details, and the document itself.

3. Attributes

Attribute	Type	Description
CompanyDocumentId	int	Unique identifier for the company document.
CompanyId	int	Identifier for the associated company.
DocumentName	string	Name of the document.
OriginalFileName	string	Original file name of the document.
DocumentType	string	Type or category of the document.
CurrentDocument	short	Indicator for the current version of the document.
CreateDate	DateTime	Date and time when the document record was created.
CreatedBy	string	User or entity who created the document.
UserId	int	Identifier for the user associated with the document.
Pub	short	Indicator for the publication status of the document.
CustomerViewable	short	Indicator for whether the document is viewable by customers.
Document	byte[]	Binary data of the document.
FileExtension	string	File extension of the document.
Keywords	string	Keywords associated with the document.
ModifiedDate	DateTime?	Date and time when the document record was last modified.
ModifiedBy	string	User or entity who last modified the document.
SecurityLevel	string	Security level assigned to the document.
RetentionDate	DateTime?	Date until which the document should be retained.
Size	int?	Size of the document in bytes.

Company Notes

1. Endpoint: `/companynotes/`

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The `CompanyNotes` class represents notes associated with companies in the system. Each instance of this class corresponds to a unique company note, containing information such as note type, creation details, and the content of the note.

3. Attributes

Attribute	Type	Description
CompanyNoteId	int	Unique identifier for the company note.
CompanyId	int	Identifier for the associated company.
UserId	int	Identifier for the user associated with the note.
CreateDate	DateTime	Date and time when the note record was created.
NoteType	string	Type or category of the note.
Pub	short	Indicator for the publication status of the note.
Note	string	Content of the note.
UseAsPopUp	bool	Indicator for whether the note can be used as a pop-up.
PopUpOnChild	bool?	Indicator for whether the pop-up is displayed on child records.

Contacts

1. Endpoint: /contacts/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The Contacts class represents individual contacts associated with companies in the system. Each instance of this class corresponds to a unique contact record, containing information such as name, contact details, and additional attributes related to communication and personal information.

3. Attributes

Attribute	Type	Description
ContactId	int	Unique identifier for the contact.
CompanyId	int	Identifier for the associated company.
Gender	string	Gender of the contact.
Salutation	string	Salutation or greeting for the contact.
FirstName	string	First name of the contact.
MiddleName	string	Middle name of the contact.
LastName	string	Last name of the contact.
LastNameSuffix	string	Suffix for the last name of the contact.
ContactName	string	Full name of the contact.
NickName	string	Nickname or informal name for the contact.
Title	string	Professional title or position of the contact.
Department	string	Department or division in the company for the contact.
Extension	string	Phone extension for the contact.
DirectPhone	string	Direct phone number for the contact.
DirectFax	string	Direct fax number for the contact.
MobilePhone	string	Mobile phone number for the contact.
MobileCarrier	string	Mobile carrier information for the contact.
PagerPhone	string	Pager phone number for the contact.
HomePhone	string	Home phone number for the contact.
WorkEmail	string	Work email address for the contact.
OtherEmail	string	Alternate or additional email address for the contact.
AccountingId	string	Accounting identifier for the contact.
Birthday	DateTime	Date of birth for the contact.
Anniversary	DateTime	Anniversary date for the contact.
SpouseName	string	Name of the spouse of the contact.
ContactType	string	Type or category of the contact.
MailingList	short	Indicator for the inclusion of the contact in mailing lists.
Deleted	short	Indicator for the deletion status of the contact.
DeletedDate	DateTime?	Date and time when the contact was deleted.
UserId	int	Identifier for the user associated with the contact.
Createdate	DateTime	Date and time when the contact record was created.
WebUserName	string	Username for web-related services.
WebPassword	string	Password for web-related services.
MailStop	string	Mail stop information for the contact.
LetterDate	DateTime?	Date and time of the letter for the contact.
TaxCode	string	Tax code information for the contact.
EntryId	string	Identifier for the entry related to the contact.
Notes	string	Additional notes or comments about the contact.
PagerPin	string	PIN for the pager of the contact.
ViewListPricing	short?	Indicator for viewing list pricing.
AcceptsSms	short?	Indicator for whether the contact accepts SMS.
ChangedPassword	string	Password change information for the contact.
DeclinedWeb	short?	Indicator for web service declination by the contact.
WebDisclaimer	short?	Indicator for web service disclaimer acceptance.
OldContactId	string	Old or historical identifier for the contact.
SlgacctId	string	Identifier for the SLG account related to the contact.
ContactStatus	string	Current status of the contact.
MainPicture	byte[]	Main picture or image associated with the contact.
GoogleContactId	string	Google Contact identifier for the contact.
SmallMainPicture	byte[]	Small-sized main picture or image for the contact.
OfdadeliveryContact	short?	Indicator for the delivery contact in OFDA.

Contact Documents

1. Endpoint: /contactdocuments/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The ContactDocuments class represents documents associated with contacts in the system. Each instance of this class corresponds to a unique contact document record, containing information such as the document type, content, and details about its creation.

3. Attributes

Attribute	Type	Description
ContactDocumentId	int	Unique identifier for the contact document.
ContactId	int	Identifier for the associated contact.
DocumentName	string	Name or title of the contact document.
OriginalFileName	string	Original name of the file before upload.
DocumentType	string	Type or category of the contact document.
CurrentDocument	short	Indicator for the current version of the document.
CreateDate	DateTime	Date and time when the document was created.
CreatedBy	string	User who created the contact document.
UserId	int	Identifier for the user who created the document.
Pub	short	Indicator for the public visibility of the document.
CustomerViewable	short	Indicator for customer visibility of the document.
Document	image	Binary data representing the content of the document.
FileExtension	string	Extension of the uploaded file.
Keywords	text	Keywords or tags associated with the document.
ModifiedDate	DateTime?	Date and time when the document was last modified.
ModifiedBy	string	User who last modified the contact document.
SecurityLevel	string	Level of security assigned to the document.
RetentionDate	DateTime?	Date until which the document is retained.
Size	int?	Size of the document in bytes.

Contact Notes

1. Endpoint: /contactnotes/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The ContactNotes class represents notes associated with contacts in the system. Each instance of this class corresponds to a unique contact note record, containing information such as the note type, content, and details about its creation.

3. Attributes

Attribute	Type	Description
ContactNoteId	int	Unique identifier for the contact note.
ContactId	int	Identifier for the associated contact.
UserId	int	Identifier for the user who created the note.
CreateDate	DateTime	Date and time when the note was created.
NoteType	string	Type or category of the contact note.
Pub	short	Indicator for the public visibility of the note.
Note	text	Text content of the contact note.
SalesLeadId	int?	Identifier for the associated sales lead.
UseAsPopUp	bool?	Indicator for using the note as a pop-up.
PopUpOnChild	bool?	Indicator for displaying pop-ups on child items.

Employees

1. Endpoint: /employees/

GET, PUT, POST, and DELETE requests are supported.

2. General Object Description

The Employees class represents information about employees within the system. Each instance of this class corresponds to a unique employee record, capturing details such as personal information, contact details, employment specifics, and other relevant attributes.

3. Attributes

Attribute	Type	Description
EmployeeId	int	Unique identifier for the employee.
FirstName	string	First name of the employee.
MiddleName	string	Middle name of the employee.
LastName	string	Last name of the employee.
Title	string	Job title of the employee.
Gender	string	Gender of the employee.
Ethnicity	string	Ethnicity of the employee.
Address	string	Primary address of the employee.
Address2	string	Secondary address of the employee.
City	string	City of residence for the employee.
State	string	State abbreviation for the employee’s location.
Zip	string	ZIP code for the employee’s address.
Phone1	string	Primary phone number of the employee.
Phone2	string	Secondary phone number of the employee.
Ss	string	Social Security number of the employee.
Dlnumber	string	Driver’s license number of the employee.
Birthday	DateTime	Birthdate of the employee.
HireDate	DateTime	Date when the employee was hired.
InsuranceStartDate	DateTime?	Start date of insurance coverage for the employee.
PtostartDate	DateTime?	Start date for Paid Time Off (PTO) for the employee.
TerminationDate	DateTime?	Date when the employee was terminated.
SupervisorId	int	Identifier of the supervisor for the employee.
Supervisor	string	Name of the supervisor for the employee.
EmployeeCoverage	string	Coverage details for the employee.
RequireSs	short	Requirement for Social Security number.
RequireProject	short	Requirement for a project.
ShowTime	short	Indicator to show time.
StartTime	string	Start time for the employee.
EndTime	string	End time for the employee.
LunchStart	DateTime?	Start time for lunch.
LunchEnd	DateTime?	End time for lunch.
Break1Start	DateTime?	Start time for break 1.
Break1End	DateTime?	End time for break 1.
Break2Start	DateTime?	Start time for break 2.
Break2End	DateTime?	End time for break 2.
LastReviewDate	DateTime?	Date of the last performance review.
ReviewIncrement	int?	Increment for reviews.
ReviewText	string	Text associated with the review.
NextReviewDate	DateTime?	Date of the next performance review.
EmployeeType	short	Type of employee.
EmployeeTypeText	string	Text representation of the employee type.
PayRate	decimal	Hourly pay rate for the employee.
PayType	string	Type of payment for the employee.
OvertimeType	short?	Type of overtime for the employee.
OvertimeTypeText	string	Text representation of the overtime type.
PaidLunch	short?	Indicator for paid lunch.
HolidayPay	short?	Indicator for holiday pay.
SickDays	double	Number of sick days available for the employee.
Pto	double	Paid Time Off (PTO) available for the employee.
BasePto	short	Base PTO for the employee.
Ptoaccrues	short	PTO accrual rate for the employee.
CreateDate	DateTime	Date when the employee record was created.
UserId	int	User identifier associated with the employee.
OvertimeRate	string	Overtime pay rate for the employee.
OvertimeRateNumber	decimal?	Numeric representation of the overtime rate.
TimeZone	string	Time zone of the employee.
TimeZoneNumber	int?	Numeric representation of the time zone.
SystemTime	short	System time indicator.
BillableTime	short?	Billable time indicator.
EmployeeNumber	string	Employee identification number.
PerJobAdditions	decimal?	Additional payment per job for the employee.
EmanageUserId	int?	User identifier for eManagement system.
Tech	string	Technical role or skills of the employee.
Installer	string	Installation role or skills of the employee.
EmanageUser	string	User representation for eManagement system.
UseDayRate	short?	Indicator for using a day rate.
InventoryLocationId	int?	Identifier for the inventory location.
Dlclass	string	Driver’s license class.
MbobjectId	int	Identifier for an object.
RequireWorkPerformed	short	Requirement for work performance.
PotPercentage	decimal?	Percentage for a potential bonus.
CrewLeader	short?	Indicator for being a crew leader.
IsPieceRatePay	short?	Indicator for piece rate pay.
CompanyCode	string	Code associated with the company.
VacationRetention	decimal?	Retention amount for vacation.
GasAllowance	decimal?	Allowance for gas.
IsBudgetPay	short?	Indicator for budgeted pay.
PerPieceScheduleId	int?	Identifier for per-piece pay schedule.
AutoLuchGroupId	int?	Identifier for the auto lunch group.
CorporateDivisionId	int?	Identifier for the corporate division.
CurrentStation	string	Current station or location of the employee.
CurrentLocation	int?	Identifier for the current location.
CurrentTableNumber	int?	Table number associated with the current location.
QblistId	string	QuickBooks list identifier.
AutoDriveTimeHours	decimal?	Hours of automatic drive time.
Salesperson	string	Salesperson associated with the employee.
CurrentTimeZoneOffset	decimal?	Current time zone offset.
TimeZoneValue	short

Employee Times (Time Sheets)

Endpoint: /employeeTime/

GET, PUT, POST, and DELETE requests are supported.

General Description

The EmployeeTime object represents a time clock entry for an employee. It includes information about the employee’s work hours, breaks, overtime, and other related details. This API provides endpoints to manage and retrieve data related to employee time entries.

Attributes

Attribute	Type	Description
TimeClockId	int	Unique identifier for the time clock entry.
EmployeeId	int	Identifier of the associated employee.
AuditDate	DateTime	Date of the time clock entry.
ProjectId	int?	Identifier of the associated project (nullable).
TimeIn	DateTime?	Time when the employee clocked in.
LunchTimeOut	DateTime?	Time when the lunch break started.
LunchTimeIn	DateTime?	Time when the lunch break ended.
TimeOut	DateTime?	Time when the employee clocked out.
TotalHours	double?	Total hours worked.
Overtime	double?	Overtime hours worked.
AdminTime	double?	Admin time hours.
AdminTimeReason	string	Reason for admin time.
OverTimeFlag	short	Flag indicating overtime.
InconsistentFlag	short	Flag indicating inconsistency in time.
PaidSickDay	short	Flag indicating a paid sick day.
PaidPtoday	short	Flag indicating a paid PTO day.
UnPaidSickDay	short	Flag indicating an unpaid sick day.
UnPaidPto	short	Flag indicating an unpaid PTO day.
PaidHoliday	short?	Flag indicating a paid holiday (nullable).
CreateDate	DateTime	Date when the time clock entry was created.
InMeeting	short?	Flag indicating the employee is in a meeting (nullable).
MobileLogin	short?	Flag indicating a mobile login (nullable).
TimeInActual	DateTime?	Actual time when the employee clocked in.
LunchTimeOutActual	DateTime?	Actual time when the lunch break started.
LunchTimeInActual	DateTime?	Actual time when the lunch break ended.
TimeOutActual	DateTime?	Actual time when the employee clocked out.
Break1Out	DateTime?	Time when break 1 started.
Break1In	DateTime?	Time when break 1 ended.
Break2Out	DateTime?	Time when break 2 started.
Break2In	DateTime?	Time when break 2 ended.
OverTimeApproved	short?	Flag indicating approved overtime (nullable).
OverTimeApprovedBy	string	User who approved the overtime.
OverTimeApprovedDate	DateTime?	Date when overtime was approved.
StartTime	DateTime?	Start time for the employee.
EndTime	DateTime?	End time for the employee.
LunchTimeStart	DateTime?	Start time for lunch break.
LunchTimeEnd	DateTime?	End time for lunch break.
AbsenceVerified	short?	Flag indicating absence verification (nullable).
AbsenceReason	string	Reason for employee absence.
OverTimeReason	string	Reason for overtime.
InconsistentReason	string	Reason for inconsistency in time.
AdminTimeApproved	short?	Flag indicating approved admin time (nullable).
AdminTimeApprovedBy	string	User who approved the admin time.
AdminTimeApprovedDate	DateTime?	Date when admin time was approved.
EntryCompleted	short	Flag indicating if the time entry is completed.
OvertimeRate	decimal?	Overtime pay rate.
PayRate	decimal?	Hourly pay rate.
RegularPay	double?	Regular pay amount.
Otpay	double?	Overtime pay amount.
WorkPerformed	string	Description of work performed.
OtpayRate	decimal?	Overtime pay rate.
OtpayAmount	double?	Overtime pay amount.
InternalCostHr	decimal?	Internal cost per hour.
OtinternalCostHr	decimal?	Overtime internal cost per hour.
InternalCostAmount	double?	Internal cost amount.
OtinternalCostAmount	double?	Overtime internal cost amount.
BillablePayRate	decimal?	Billable pay rate.
OtbillablePayRate	decimal?	Overtime billable pay rate.
BillableAmount	double?	Billable amount.
OtbillableAmount	double?	Overtime billable amount.
ActualCostHr	decimal?	Actual cost per hour.
OtactualCostHr	decimal?	Overtime actual cost per hour.
ActualCostAmount	double?	Actual cost amount.
OtactualCostAmount	double?	Overtime actual cost amount.
PaySchedule	string	Pay schedule for the employee.
PerJobAdditions	decimal?	Additional payment per job.
UseDoubleTime	short?	Flag indicating the use of double time (nullable).
AutoCreated	short?	Flag indicating if the entry was automatically created (nullable).
EntryCode	string	Code associated with the entry.
EntryType	string	Type of entry (e.g., regular, overtime).
MbcostCodeRef	int	Reference to the cost code.
MbpayType	int	Type of pay associated with the entry.
MbobjectId	int	Identifier for an object.
UserId	int?	User identifier associated with the entry.
Ga	decimal?	General and Administrative (GA) cost.
GCode	string	Code associated with GA cost.
CustomerReference	string	Reference to the customer.
WorkingpunchId	int?	Identifier for the associated working punch.
Phase	string	Phase associated with the entry.
DoubleTime	double?	Double time hours.
DoubleTimePayRate	decimal?	Double time pay rate.
DoubleTimePay	double?	Double time pay amount.
DtactualCostHr	decimal?	Double time actual cost per hour.
DtactualCost	double?	Double time actual cost amount.
ReferenceId	int?	Identifier for the associated reference (nullable).
ReferenceType	string	Type of reference.
ServiceTicketId	int?	Identifier for the associated service ticket (nullable).
TravelTimePaySchedule	string	Pay schedule for travel time.
OvertimePaySchedule	string	Pay schedule for overtime.
TravelTimePayRate	decimal?	Pay rate for travel time.
ProjectOrderId	int?	Identifier for the associated project order (nullable).
TravelTime	double?	Travel time hours.
TravelTimePay	double?	Travel time pay amount.
TravelTimeCostRate	decimal?	Cost rate for travel time.
TravelTimeCost	double?	Cost amount for travel time.
TotalSheetCost	double?	Total cost for the sheet.
SentToQb	short?	Flag indicating if the entry is sent to QuickBooks (nullable).
RgsentToQb	short?	Flag indicating if regular time is sent to QuickBooks (nullable).
OtsentToQb	short?	Flag indicating if overtime is sent to QuickBooks (nullable).
TravelSentToQb	short?	Flag indicating if travel time is sent to QuickBooks (nullable).
TravelTimeStart	DateTime?	Start time for travel time.
TravelTimeEnd	DateTime?	End time for travel time.
TravelTime2Start	DateTime?	Start time for second travel time.
TravelTime2End	DateTime?	End time for second travel time.
TravelTime2	double?	Second travel time hours.
ProjectInstallationId	int?	Identifier for the associated project installation (nullable).
PreventativeMaintenanceId	int?	Identifier for the associated preventative maintenance (nullable).
ServiceScheduleId	int?	Identifier for the associated service schedule (nullable).
ProjectServiceId	int?	Identifier for the associated project service (nullable).
LunchHour	double?	Lunch break duration in hours.
DriveTimeInGeo	string	Geographic location for drive time in.
DriveTimeOutGeo	string	Geographic location for drive time out.
TimeInGeo	string	Geographic location for time in.
LunchTimeOutGeo	string	Geographic location for lunch time out.
LunchTimeInGeo	string	Geographic location for lunch time in.
TimeOutGeo	string	Geographic location for time out.
DriveTime2InGeo	string	Geographic location for second drive time in.
DriveTime2OutGeo	string	Geographic location for second drive time out.
SheetType	string	Type of sheet associated with the entry.
DoubleTimePaySchedule	string	Pay schedule for double time.
DtsentToQb	short?	Flag indicating if double time is sent to QuickBooks (nullable).
DriveTimeInLat	double?	Latitude for drive time in.
DriveTimeInLong	double?	Longitude for drive time in.
DriveTimeOutLat	double?	Latitude for drive time out.
DriveTimeOutLong	double?	Longitude for drive time out.
TimeInLat	double?	Latitude for time in.
TimeInLong	double?	Longitude for time in.
LunchTimeOutLat	double?	Latitude for lunch time out.
LunchTimeOutLong	double?	Longitude for lunch time out.
LunchTimeInLat	double?	Latitude for lunch time in.
LunchTimeInLong	double?	Longitude for lunch time in.
TimeOutLat	double?	Latitude for time out.
TimeOutLong	double?	Longitude for time out.
DriveTime2InLat	double?	Latitude for second drive time in.
DriveTime2InLong	double?	Longitude for second drive time in.
DriveTime2OutLat	double?	Latitude for second drive time out.
DriveTime2OutLong	double?	Longitude for second drive time out.
OriginatingTimeClockId	int?	Identifier for the originating time clock entry (nullable).

Installation Schedule

Endpoint: /projectInstallationSchedule/

GET, PUT, POST, and DELETE requests are supported.

General Description

The ProjectInstallationSchedule object represents the schedule for the installation phase of a project. It contains information about the start and end dates, installation type, division, man-hours, and other related details. This API provides endpoints to manage and retrieve data related to project installation schedules.

Attributes

Attribute	Type	Description
ProjectInstallationId	int	Unique identifier for the project installation schedule.
ProjectId	int	Identifier of the associated project.
StartDate	DateTime	Start date of the installation schedule.
EndDate	DateTime	End date of the installation schedule.
StartTime	DateTime	Start time of the installation schedule.
HoursPerDay	double	Hours of work per day.
UserId	int	User identifier associated with the schedule.
CreateDate	DateTime	Date when the installation schedule was created.
InstallationType	string	Type of installation (e.g., electrical, plumbing).
Division	string	Division associated with the installation.
TotalManhours	double	Total man-hours estimated for the installation.
AuditDateStart	DateTime	Start date for auditing purposes.
AuditDateEnd	DateTime	End date for auditing purposes.
BackColor	string	Background color for visual representation.
ForeColor	string	Foreground color for visual representation.
ProjectPhaseId	int?	Identifier of the associated project phase (nullable).
CollectPayment	short?	Flag indicating if payment is to be collected (nullable).
PaymentAmount	decimal?	Amount to be collected for the installation.
PaymentCollected	short?	Flag indicating if payment has been collected (nullable).
CollectedAmount	decimal?	Amount collected for the installation.
OnHold	short?	Flag indicating if the installation is on hold (nullable).
B4	short?	Flag indicating B4 status (nullable).
CompletedOn	DateTime?	Date when the installation was completed (nullable).
CorporateDivisionId	int?	Identifier of the associated corporate division (nullable).
Redo	short?	Flag indicating if the installation needs to be redone (nullable).
ProjectOrderId	int?	Identifier of the associated project order (nullable).
RequestedInstallersPerDay	short?	Number of requested installers per day (nullable).
RequestedInstallationDays	short?	Number of requested installation days (nullable).
RequestedTrucks	short?	Number of requested trucks (nullable).
GeneralInstructions	string	General instructions for the installation.
OriginalInstallationId	int?	Identifier of the original installation (nullable).
PrintInstallers	short?	Flag indicating if installers should be printed (nullable).
PrintSubcontractors	short?	Flag indicating if subcontractors should be printed (nullable).
PrintScopeOfWork	short?	Flag indicating if the scope of work should be printed (nullable).
PrintPunchList	short?	Flag indicating if the punch list should be printed (nullable).
PrintMap	short?	Flag indicating if the map should be printed (nullable).
PrintProjectName	short?	Flag indicating if the project name should be printed (nullable).
PrintOrderName	short?	Flag indicating if the order name should be printed (nullable).
HasSpecialInstructions	short?	Flag indicating if there are special instructions (nullable).
PrintContacts	short?	Flag indicating if contacts should be printed (nullable).
GeneralInstructionsHtml	string	General instructions in HTML format.

Installation Installers

Endpoint: /projectInstallationInstallers/

GET, PUT, POST, and DELETE requests are supported.

General Description

The ProjectInstallationInstallers object represents the installers associated with a project installation schedule. This API provides endpoints to manage and retrieve data related to project installation installers, including details about their work, pay, ratings, and schedule.

Attributes

Attribute	Type	Description
ProjectInstallationInstallerId	int	Unique identifier for the project installation installer.
ProjectInstallationId	int	Identifier of the associated project installation.
Installer	string	Name of the installer.
Installing	string	Description of what the installer is installing.
BillableServiceSchedule	string	Type of service schedule for billing purposes.
PaySchedule	string	Pay schedule for the installer.
PayrollCreated	short?	Flag indicating if payroll has been created (nullable).
Rating	string	Rating assigned to the installer’s performance.
RatingNotes	string	Additional notes or comments related to the rating.
StartTime	DateTime?	Start time of the installation work (nullable).
EndTime	DateTime?	End time of the installation work (nullable).
Confirmed	short	Confirmation status of the installer.
TimeClockId	int?	Identifier of the associated time clock entry (nullable).
TravelTime	decimal?	Amount of travel time (in hours).
TravelTimeStart	DateTime?	Start time of travel time (nullable).
TravelTimeEnd	DateTime?	End time of travel time (nullable).
TravelTimePaySchedule	string	Pay schedule for travel time.
OvertimePaySchedule	string	Pay schedule for overtime.
TravelTime2	decimal?	Additional travel time (in hours).
TravelTime2Start	DateTime?	Start time of additional travel time (nullable).
TravelTime2End	DateTime?	End time of additional travel time (nullable).
LunchHour	double?	Duration of lunch break (in hours).
LunchTimeOut	DateTime?	Time when lunch break starts (nullable).
LunchTimeIn	DateTime?	Time when lunch break ends (nullable).
DoubleTimePaySchedule	string	Pay schedule for double time.

SalesLeads

Endpoint: /salesleads/

Supported HTTP Methods

GET, PUT, POST, and DELETE requests are supported.

General Description

The SalesLeads object represents information about sales leads, capturing details such as contact information, lead creation date, salesperson details, and various other attributes related to sales activities.

Attributes

Attribute	Type	Description
SalesLeadId	int	Unique identifier for the sales lead.
ContactId	int	Identifier of the associated contact.
LeadNumber	string (24)	Unique number associated with the lead.
CreateDate	DateTime	Date and time when the lead was created.
ProjectId	int?	Identifier of the associated project (nullable).
Salesperson	string (125)	Name of the salesperson associated with the lead.
Type	string (125)	Type of the sales lead.
ReferredBy	string (125)	Source or reference by which the lead was obtained.
UserId	int	Identifier of the user associated with the lead.
Interest	string (text)	Detailed information about the lead’s interest.
Deleted	short	Flag indicating if the lead is deleted.
DeletedBy	string (45)	User who deleted the lead.
DeleteDate	DateTime?	Date and time when the lead was deleted (nullable).
DeletedReason	string (255)	Reason for deleting the lead.
LastActivityDate	DateTime?	Date of the last activity associated with the lead.
LeadLetterDate	DateTime?	Date of the last letter sent to the lead.
LeadEmailDate	DateTime?	Date of the last email sent to the lead.
MarketingCampaignId	int?	Identifier of the associated marketing campaign (nullable).
Priority	string (85)	Priority level of the lead.
NextEventDate	DateTime?	Date of the next scheduled event related to the lead.
NextEventType	string (85)	Type of the next scheduled event.
NextEventregarding	string (255)	Regarding information for the next scheduled event.
NextFollowUpDate	DateTime?	Date of the next scheduled follow-up.
NextFollowUpType	string (85)	Type of the next scheduled follow-up.
NextFollowUpRegarding	string (400)	Regarding information for the next scheduled follow-up.
LastNoteAdded	DateTime?	Date of the last note added to the lead.
LastLetterMerged	DateTime?	Date of the last letter merged with the lead.
LastLetterName	string (255)	Name of the last merged letter.
Status	string (85)	Current status of the lead.
ApproxValue	decimal?	Approximate value associated with the lead.
Probability	string (85)	Probability of lead conversion.
DecisionDate	DateTime?	Date of the decision related to the lead.
ReturnedToCompany	short?	Flag indicating if the lead is returned to the company (nullable).
SalespersonReturned	string (85)	Salesperson who returned the lead.
IsPending	short	Flag indicating if the lead is pending.
PendingUserId	int?	Identifier of the user associated with the pending status (nullable).
PendingDate	DateTime?	Date of the pending status.
PendingReason	string (text)	Reason for the pending status.
PendingReactivationDate	DateTime?	Date for reactivation from pending status.
Approved	short?	Flag indicating if the lead is approved (nullable).
CarrierId	int?	Identifier of the associated carrier (nullable).
NextTouchType	string (85)	Type of the next touchpoint with the lead.
NextTouchDate	DateTime?	Date of the next scheduled touchpoint.