MENU navbar-image

Introduction

Welcome to the API reference.

Production

SandBox

Release Notes

v8.45.0

v8.44.0

v8.43.1

# filterTag PATCH endpoint request body example
{
  "data": {
    "id": [
      "33144d9c-7983-11ef-a7bd-00fff7b445c2",
      "331462a4-7983-11ef-a7bd-00fff7b445c2"
    ]
  }
}

v8.43.0

v8.42.0

v8.38.0

v8.37.0

v8.35.0

v8.33.0

v8.32.0

v8.31.0

v8.28.0

v8.25.0

v8.22.0

v8.21.0

v8.20.0

v8.19.0

v8.15.0

Authentication

Prime Ecosystem API uses OAuth 2.0 to authenticate application requests. We use the Password grant type to issue the tokens.

Please contact Prime administrator for the API integration. Once you are signed up, we will link your App to a user and email you the client key and secret.

Getting an Access Token

POST {api_uri}/oauth/token

Response example
{
    "token_type": "Bearer",
    "expires_in": 1295999,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjYyMTg5MzU4ODM3YmFiYWVlZWFjYzk1Njk3ZTUwZmFlMzRhYjk5ZGFmOWNiNDY5YmU2Y2RhMjdmNGZjNjRjNmE0NWJiZmI4YWJiYTlkMmYxIn0.eyJhdWQiOiIwMmIwOWE1OC00ZGFlLTRhYjgtODBjYi0zOTcyNjU5ZmUyNjEiLCJqdGkiOiI2MjE4OTM1ODgzN2JhYmFlZWVhY2M5NTY5N2U1MGZhZTM0YWI5OWRhZjljYjQ2OWJlNmNkYTI3ZjRmYzY0YzZhNDViYmZiOGFiYmE5ZDJmMSIsImlhdCI6MTU0ODQyMTgzMCwibmJmIjoxNTQ4NDIxODMwLCJleHAiOjE1NDk3MTc4MjksInN1YiI6IjIiLCJzY29wZXMiOltdfQ.Emq7-gYFg4UCQI1OtaLSDGhUxnfL7SGXTe1za4mOI4DLe8R-UMivn7lIFHJaLa2m2KIvoEnxBGwpTvXu7cWFT2IhdwwBjhp4ntDCcwCR3VxKqKsK2JwHIKuujMPkW7laHzpScP0C-KwHrQPZZalWF3wRQ50WB5CJI1YFyWiQxtM1fwMl3ql9BE1bLGGkBD6SZu3QsRA3pkQBe108Ux97d1Yzyzxp-jcFrRFEeUapaIKQOuyHpLGgCzPrt7W0MFUrqE8hIde9E6PA1ardDL5qYNg0CgTJkozizfO5LHPzGR4pdI_ObKVSRNxFWZwIDolfA_TDP0dRoSGKMTsibkJ2SyhRXQTFraItP-5zmBqrmGQPSVvGSNqJ-DU2frQ61ZsmTvTB9n4Ep81Ll1nuAdQkk8ErygeBlqjqzgEJtBNXsZu6gkKt63hS5NXANI3Q5YdShWbF9PZ4chGQ2vRHimeHe_-IhZiV8HNwTdVljsbGZOx3al3g5jHRoUimZVRh2v34mTIl5UBwxS4D1KP4qsnzOlOfjkR_pxIMjzMHeFJylkXwaXVelpnY60lTTvGJdYFkukkJR7EdGQJaVzNd2V1zOYMQ_ZHJBhGQcNzFxMh-ttTDkCyqTTxHP_BiF3hfwvZbCajpO442XBFOv-58ps-OxQccvdn1mbYfth0VT9aOblE",
    "refresh_token": "def502004b6007189733b7576cbb66938181a76cb6e9ae9459714ee9c29630a16d996e9965ddf143d956729d8bee61ecead9de278c4db64da0d788740c788b8034eab0345181f1fadfc01f75318ade38ec9949916852e4fee09b3b20c3cae00c6c2d252fbbe557d3769ebf33b951a79b75adce85fe75f4d135ebcfb32778f5c99725ebd3a78272cf56a4e32927b4f33c8d2d4c893079192ec9cd1daa04e2628bc62266f3f6d3d012c2298fde87f5225c00740c0f0bd02025c1752b9b107f93e28cb85d4a910386d0b23f47ffc977e206a8b8c757131ba68eb63176ac29e070c3218771cb2d40f27072e9fed4714355c696e6d553eabd94509555ddd05d196df1e357410813e16b20395348bca0f5d0e2a1add4fa1c8455f1611d0906c11e38ceba1a5feec20b0bbb53dc0d784b08a016398548a0812fef484470244d6ba859afa4e5fbc5f7146e7f28adceb19a65d7ada273a8bc7943159a10dd09ce4fd6851cacffce29adba1e4f74c72fd9fc4ff50d3d1877c8f498614cfee1a15a6a06e998b442bb15"
}
Key Value
Content-Type application/x-www-form-urlencoded
Accept application/vnd.api.v2+json

Body

Key Value
grant_type password
username {username}
password {password}
client_id {client_id}
client_secret {client_secret}

Refreshing an Access Token

POST {api_uri}/oauth/token

Response Example
{
    "token_type": "Bearer",
    "expires_in": 1295999,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjYyMTg5MzU4ODM3YmFiYWVlZWFjYzk1Njk3ZTUwZmFlMzRhYjk5ZGFmOWNiNDY5YmU2Y2RhMjdmNGZjNjRjNmE0NWJiZmI4YWJiYTlkMmYxIn0.eyJhdWQiOiIwMmIwOWE1OC00ZGFlLTRhYjgtODBjYi0zOTcyNjU5ZmUyNjEiLCJqdGkiOiI2MjE4OTM1ODgzN2JhYmFlZWVhY2M5NTY5N2U1MGZhZTM0YWI5OWRhZjljYjQ2OWJlNmNkYTI3ZjRmYzY0YzZhNDViYmZiOGFiYmE5ZDJmMSIsImlhdCI6MTU0ODQyMTgzMCwibmJmIjoxNTQ4NDIxODMwLCJleHAiOjE1NDk3MTc4MjksInN1YiI6IjIiLCJzY29wZXMiOltdfQ.Emq7-gYFg4UCQI1OtaLSDGhUxnfL7SGXTe1za4mOI4DLe8R-UMivn7lIFHJaLa2m2KIvoEnxBGwpTvXu7cWFT2IhdwwBjhp4ntDCcwCR3VxKqKsK2JwHIKuujMPkW7laHzpScP0C-KwHrQPZZalWF3wRQ50WB5CJI1YFyWiQxtM1fwMl3ql9BE1bLGGkBD6SZu3QsRA3pkQBe108Ux97d1Yzyzxp-jcFrRFEeUapaIKQOuyHpLGgCzPrt7W0MFUrqE8hIde9E6PA1ardDL5qYNg0CgTJkozizfO5LHPzGR4pdI_ObKVSRNxFWZwIDolfA_TDP0dRoSGKMTsibkJ2SyhRXQTFraItP-5zmBqrmGQPSVvGSNqJ-DU2frQ61ZsmTvTB9n4Ep81Ll1nuAdQkk8ErygeBlqjqzgEJtBNXsZu6gkKt63hS5NXANI3Q5YdShWbF9PZ4chGQ2vRHimeHe_-IhZiV8HNwTdVljsbGZOx3al3g5jHRoUimZVRh2v34mTIl5UBwxS4D1KP4qsnzOlOfjkR_pxIMjzMHeFJylkXwaXVelpnY60lTTvGJdYFkukkJR7EdGQJaVzNd2V1zOYMQ_ZHJBhGQcNzFxMh-ttTDkCyqTTxHP_BiF3hfwvZbCajpO442XBFOv-58ps-OxQccvdn1mbYfth0VT9aOblE",
    "refresh_token": "def502004b6007189733b7576cbb66938181a76cb6e9ae9459714ee9c29630a16d996e9965ddf143d956729d8bee61ecead9de278c4db64da0d788740c788b8034eab0345181f1fadfc01f75318ade38ec9949916852e4fee09b3b20c3cae00c6c2d252fbbe557d3769ebf33b951a79b75adce85fe75f4d135ebcfb32778f5c99725ebd3a78272cf56a4e32927b4f33c8d2d4c893079192ec9cd1daa04e2628bc62266f3f6d3d012c2298fde87f5225c00740c0f0bd02025c1752b9b107f93e28cb85d4a910386d0b23f47ffc977e206a8b8c757131ba68eb63176ac29e070c3218771cb2d40f27072e9fed4714355c696e6d553eabd94509555ddd05d196df1e357410813e16b20395348bca0f5d0e2a1add4fa1c8455f1611d0906c11e38ceba1a5feec20b0bbb53dc0d784b08a016398548a0812fef484470244d6ba859afa4e5fbc5f7146e7f28adceb19a65d7ada273a8bc7943159a10dd09ce4fd6851cacffce29adba1e4f74c72fd9fc4ff50d3d1877c8f498614cfee1a15a6a06e998b442bb15"
}
Key Value
Content-Type application/x-www-form-urlencoded
Accept application/vnd.api.v2+json

Body

Key Value
grant_type refresh_token
client_id {client_id}
client_secret {client_secret}
refresh_token {refresh_token}

API Overview

Timezone: By default all Datetime values are in UTC, unless there's timezone field which has a different value.

API Limits

API Rate Limit

API Rate Limit headers

Request Size Limit

A single POST to API has a size limit of 25MB

API Headers

Key Value
Authorization Bearer {access_token}
Accept application/vnd.api.v2+json
Content-Type application/json

API Retrieving Data

Get Resource List

{apipath}/perils?per_page=5&page=1

Response example

{
    "data": [
        {
            "type": "peril",
            "id": "ec156c70-fa52-32b0-efd9-bfeea10e0623",
            "attributes": {
                "label": "No peril",
                "version": 0
            }
        },
        {
            "type": "peril",
            "id": "192ebfa5-8ae3-7607-b4c0-faea51b2c931",
            "attributes": {
                "label": "Storm",
                "version": 0
            }
        },
        {
            "type": "peril",
            "id": "6ca97990-64d8-e18e-e95f-f651a7a79c29",
            "attributes": {
                "label": "Water damage",
                "version": 0
            }
        },
        {
            "type": "peril",
            "id": "ea334c27-7b63-6f44-f5b3-aa1a8543ee6a",
            "attributes": {
                "label": "Fire",
                "version": 0
            }
        },
        {
            "type": "peril",
            "id": "bffbd8eb-5f02-eec9-78ed-d1477ce11d9a",
            "attributes": {
                "label": "Lightning",
                "version": 0
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 17,
            "count": 5,
            "per_page": 5,
            "current_page": 1,
            "total_pages": 4
        }
    },
    "links": {
        "self": "http://devcon.app/api/perils?page=1",
        "first": "http://devcon.app/api/perils?page=1",
        "next": "http://devcon.app/api/perils?page=2",
        "last": "http://devcon.app/api/perils?page=4"
    }
}

Get Individual Resource

{apipath}/perils/ec156c70-fa52-32b0-efd9-bfeea10e0623

Response example

{
    "data": {
        "type": "peril",
        "id": "ec156c70-fa52-32b0-efd9-bfeea10e0623",
        "attributes": {
            "label": "No peril",
            "version": 0
        }
    }
}

Getting Started

Use the HTTP GET method to retrieve data via API. This includes both lists and individual resource. Get resource list: GET {api_uri}/{resource-end-point} Get individual resource: GET {api_uri}/{resource-end-point}/{id}

Pagination

To page through the results, specify page (page number, starting from 1) and per_page (maximum number of items in the result, default value is 15).

Ordering

To sort the results of a query, include the order query string. The format is order=columnName[|sortOrder]. The default sort order is ascending. To indicate descending sort order, include DESC. For example order=lastName or order=updatedAt|DESC.

Filtering

Use Query string q= to filter results. For example, to filter work order by the created datetime(UTC): {{apipath}}/work-orders?q='createdAt'.gte('2016-12-20 02:00:00'),'createdAt'.lte('2016-12-21 10:00:00')

Operations

And / Or

If multiple fields are being tested, its necessary to sepcify whether they should be evaluated as "and" or "or" tests.

Closures

Wrapping () brackets can be used to affect order of operations for queries.

Escaping values

Quotes (single or double) " or ' can be used to escape strings e.g. field.like("orang%") Escaping quotes: If you need to use quotes, you can use the \ character to escape the quote character

API Creating and Updating Data

Getting Started

Use the POST method to add a new item and use the PUT method to update an existing item via API.

When updating data the version field must have up-to-date value.

Update Item

{apipath}/perils/9b334265-4785-956e-d3e4-4ec0c5baf101

Request example

{
   "attributes": {
      "label": "New peril new",
      "version": 1551251098
    }
}

Sync item with filter tags example

{
   "attributes": {
      "label": "New peril new",
      "version": 1727147297
    },
    "relationships": {
        "filterTags": {
            "data": {
                "id": [
                    "33144d9c-7983-11ef-a7bd-00fff7b445c2",
                    "331462a4-7983-11ef-a7bd-00fff7b445c2"
                ]
            }
        }
    }
}

Response

The response data is the item which has been added or updated.

API Response Code

Code Summary Description
200 OK Successful API call.
401 Unauthorized Invalid authorization.
403 Forbidden API user doesn't have permission to perform the action.
404 Not Found The requested resource could not be found.
405 Method Not Allowed A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
422 Unprocessable Entity The request body fails validation.
429 Too Many Requests The user has sent too many requests in a given amount of time.
500 Internal Error Prime API server error. Contact support team if problems persist.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {access_token}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Accounts Payable Invoice

Accounts Payable Invoice Status
Approved
Awaiting Approval
Cancelled
New
Paid
Part Paid
Sent
Approved Status
Pending
Approved
Not Approved
Disputed
Under Review

List Accounts Payable Invoices

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/accounts-payable-invoices

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Accounts Payable Invoice

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "accountsPayableInvoice",
        "id": "678ae7f5-49c4-20a3-3fcb-62096c91bc0c",
        "attributes": {
            "jobId": "e637522e-24bb-28ef-7ba1-d090fda20d84",
            "invoiceNumber": "12341234",
            "workOrderId": "3279039f-4c14-d268-f5d5-3f00f28cd325",
            "accountsPayableInvoiceStatus": "New",
            "accountNumber": "1-2110",
            "itemCode": "120",
            "amount": "800.0000",
            "tax": "0.0000",
            "taxTotal": "72.7273",
            "invoicedDate": "2018-02-27",
            "dueDate": "2018-03-06",
            "attachmentId": "35486bec-a7fd-4447-8418-727b5a1ea001",
            "approvalStatus": "Disputed",
            "approvalNote": null,
            "approvedBy": "Tooly McToolface",
            "approvedAt": "2018-02-27 10:10:37",
            "createdAt": "2018-02-27 10:10:37",
            "createdBy": "Rhys James",
            "updatedAt": "2018-02-27 10:10:37",
            "updatedBy": "Rhys James",
            "isSynced": false,
            "finalInvoice": false,
            "version": 1519690237
        }
    }
}

Request   

GET {api_uri}/accounts-payable-invoices/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the accounts payable invoice. Example: 1

Create Accounts Payable Invoice

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/accounts-payable-invoices

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
invoiceNumber   string   

Invoice number Example: INV001

jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

accountsPayableInvoiceStatusId   string  optional  

Accounts Payable Invoice Status Id - required if attributes.accountsPayableInvoiceStatus is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

accountsPayableInvoiceStatus   string  optional  

Accounts Payable Invoice Status Name - required if attributes.accountsPayableInvoiceStatusId is not presented Example: New

workOrderId   string  optional  

Work Order Id - required if attributes.workOrder is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

workOrder   string  optional  

Work Order Number - required if attributes.workOrderId is not presented Example: WO001

accountNumber   string  optional  

Account Number Example: 4-1000

itemCode   string  optional  

Item Code Example: FINAL

amount   decimal  optional  

Invoice Amount Example: 5000.50

noTax   boolean  optional  

set to 1 if no tax Example: false

invoicedDate   date  optional  

Invoice Date Example: 2019-01-01

dueDate   date  optional  

Invoice Due Date Example: 2019-01-31

attachment   file  optional  

Invoice File Example: C:\Users\gordo\AppData\Local\Temp\phpA158.tmp

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

finalInvoice   boolean  optional  

set to 1 if is final invoice Example: false

Update Accounts Payable Invoice

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/accounts-payable-invoices/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the accounts payable invoice. Example: 1

Body Parameters

attributes   object  optional  
invoiceNumber   string   

Invoice number Example: INV001

jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

accountsPayableInvoiceStatusId   string  optional  

Accounts Payable Invoice Status Id - required if attributes.accountsPayableInvoiceStatus is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

accountsPayableInvoiceStatus   string  optional  

Accounts Payable Invoice Status Name - required if attributes.accountsPayableInvoiceStatusId is not presented Example: New

workOrderId   string  optional  

Work Order Id - required if attributes.workOrder is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

workOrder   string  optional  

Work Order Number - required if attributes.workOrderId is not presented Example: WO001

accountNumber   string  optional  

Account Number Example: 4-1000

itemCode   string  optional  

Item Code Example: FINAL

amount   decimal  optional  

Invoice Amount Example: 5000.50

noTax   boolean  optional  

set to 1 if no tax Example: false

invoicedDate   date  optional  

Invoice Date Example: 2019-01-01

dueDate   date  optional  

Invoice Due Date Example: 2019-01-31

attachment   file  optional  

Invoice File Example: C:\Users\gordo\AppData\Local\Temp\phpA168.tmp

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

finalInvoice   boolean  optional  

set to 1 if is final invoice Example: false

version   integer   

Version number Example: 1543444647

Update Accounts Payable Invoice Status

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1/relationships/accountsPayableInvoiceStatus" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-payable-invoices/1/relationships/accountsPayableInvoiceStatus"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/accounts-payable-invoices/{id}/relationships/accountsPayableInvoiceStatus

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the accounts payable invoice. Example: 1

Body Parameters

data   object  optional  
name   string   

Accounts Payable Invoice Status Example: Approved

version   integer   

Version number Example: 1519690237

Accounts Receivable Invoice

Accounts Receivable Invoice Status
Approved
Awaiting Approval
Cancelled
Draft
Paid
Part Paid
Pending
Sent

List Accounts Receivable Invoices

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/accounts-receivable-invoices

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Accounts Receivable Invoice

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "accountsReceivableInvoice",
        "id": "ef7a463e-97d1-2e63-8280-a9cba74a40c7",
        "attributes": {
            "jobId": "b6572f74-25c8-6d33-2a74-14812518667e",
            "invoiceNumber": "DC00056",
            "accountsReceivableInvoiceStatus": "Pending",
            "accountNumber": null,
            "invoicedDate": "2018-10-23",
            "dueDate": "2018-11-23",
            "notes": "",
            "subtotal": "174.6756",
            "total": "3493.5120",
            "taxTotal": "317.5920",
            "progressPaymentNumber": 1,
            "progressPaymentPercentage": "0.05000000",
            "accountsReceivableType": "Authorised Works",
            "showExcessAs": "",
            "invoicedTo": "e8392786-d0f8-bd31-c25f-fbd30e359b09",
            "attachmentId": "35486bec-a7fd-4447-8418-727b5a1ea001",
            "accountsReceivableInvoiceItems": [
                {
                    "id": "e5b04b2a-2a11-ecd4-c0f9-477ca4786b0f",
                    "quantity": "1.0000",
                    "unit": "Ea",
                    "rate": "158.7960",
                    "subtotal": "158.7960",
                    "includeTax": 1,
                    "tax": "0.1000",
                    "total": "174.6756",
                    "taxTotal": "15.8796",
                    "itemCode": null,
                    "allocationIds": [],
                    "version": 1541723770
                }
            ],
            "createdAt": "2018-11-09 10:34:02",
            "createdBy": "Paul George",
            "updatedAt": "2018-11-09 10:36:13",
            "updatedBy": "Paul George",
            "isSynced": false,
            "version": 1541723773
        }
    }
}

Request   

GET {api_uri}/accounts-receivable-invoices/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the accounts receivable invoice. Example: 4

Update Accounts Receivable Invoice Status

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices/4/relationships/accountsReceivableInvoiceStatus" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/accounts-receivable-invoices/4/relationships/accountsReceivableInvoiceStatus"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/accounts-receivable-invoices/{id}/relationships/accountsReceivableInvoiceStatus

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the accounts receivable invoice. Example: 4

Body Parameters

data   object  optional  
name   string   

Accounts Receivable Invoice Status Example: Pending

version   integer   

Version number Example: 1543444647

Allocation

Allocation Status
Make Safe
Plumbing Report
Electrical Report
Roof Report
Engineering Report
Assessment Report
Flooring Report
Restoration
Do & Charge
Decontamination
Architecture Design
Work Order
Building Report
Quote
Asbestos Report
PRV Report
Painting

The objectId is linked Estimate or LockedEstimate's id

List Allocations

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/allocations" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocations"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/allocations

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Allocation

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/allocations/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocations/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "allocation",
        "id": "f2c92140-c578-11ea-8bbe-080027f092e2",
        "attributes": {
            "jobId": "5cdd47ac-ee37-0793-98fb-bd4dd5230f97",
            "assignedContactId": null,
            "assignedId": "dfb8c40d-49f8-2c7d-2fbf-31dca0d45916",
            "allocationStatusId": "22a70f2c-3c0b-11ea-81c5-02784156a6b6",
            "allocationType": "Do & Charge",
            "allocationNumber": "A00001",
            "objectId": "747d8e26-48be-e769-021d-77781c956467",
            "objectType": "LockedEstimate",
            "label": "Do & Charge",
            "description": "test1",
            "limit": null,
            "siteAttended": null,
            "completed": null,
            "firstCustomerContactAt": null,
            "filterTags": [],
            "version": 1604316353
        }
    }
}

Request   

GET {api_uri}/allocations/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the allocation. Example: 1

Create Allocation

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/allocations" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocations"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/allocations

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

assignedContactId   string  optional  

Assigned User Id Example: 391bdcad-b623-fdd6-9499-4aca39f25342

assignedId   string  optional  

Assigned Subcontractor Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

allocationStatusId   string   

Allocation Status Id Example: e5c370b3-3b48-11ea-ab87-080027f092e2

allocationType   string   

Allocation type Example: Make Safe

allocationNumber   string   

Allocation Number Example: A00001

label   string   

Allocation label Example: Make Safe 12345

description   string  optional  

Allocation description Example: This is the allocation description

limit   decimal  optional  

Allocation limit Example: 123.45

siteAttended   datetime  optional  

Allocation site attended date time Example: 2020-09-01 14:05:00

completed   datetime  optional  

Allocation completed date time Example: 2020-09-01 14:05:00

firstCustomerContactAt   datetime  optional  

Allocation first customer contact date time Example: 2020-09-01 14:05:00

Update Allocation

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/allocations/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocations/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/allocations/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the allocation. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

assignedContactId   string  optional  

Assigned User Id Example: 391bdcad-b623-fdd6-9499-4aca39f25342

assignedId   string  optional  

Assigned Subcontractor Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

allocationStatusId   string   

Allocation Status Id Example: e5c370b3-3b48-11ea-ab87-080027f092e2

allocationType   string   

Allocation type Example: Make Safe

allocationNumber   string   

Allocation Number Example: A00001

label   string   

Allocation label Example: Make Safe 12345

description   string  optional  

Allocation description Example: This is the allocation description

siteAttended   datetime  optional  

Allocation site attended date time Example: 2020-09-01 14:05:00

completed   datetime  optional  

Allocation completed date time Example: 2020-09-01 14:05:00

firstCustomerContactAt   datetime  optional  

Allocation first customer contact date time Example: 2020-09-01 14:05:00

version   integer   

Version number Example: 1543444647

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/allocations/1/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocations/1/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/allocations/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the allocation. Example: 1

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

AllocationStatus

List AllocationStatuses

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/allocation-statuses" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocation-statuses"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/allocation-statuses

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get AllocationStatus

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/allocation-statuses/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/allocation-statuses/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "allocationStatus",
        "id": "e5c370b3-3b48-11ea-ab87-080027f092e2",
        "attributes": {
            "label": "new status",
            "version": 1533345093
        }
    }
}

Request   

GET {api_uri}/allocation-statuses/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the allocation status. Example: 1

Appointment

Appointment Status
New
Completed
Cancelled

List Appointments

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/appointments" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointments"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/appointments

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Appointment

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/appointments/2" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointments/2"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "appointment",
        "id": "f2c92140-c578-11ea-8bbe-080027f092e2",
        "attributes": {
            "jobId": "7b7c1013-9c44-9826-f463-920948f89aa0",
            "appointmentStatus": "Completed",
            "appointmentTypeId": "f3413a2d-c578-11ea-8bbe-080027f092e2",
            "primaryUserId": "9c0366a1-d78c-3cd8-4ac0-463517922162",
            "start": "2016-11-22 14:30:00",
            "end": "2016-11-22 15:30:00",
            "instructions": "",
            "notes": "",
            "createdAt": "2016-11-21 12:11:14",
            "createdBy": "John Smith",
            "updatedAt": "2017-03-05 00:45:42",
            "updatedBy": "John Smith",
            "version": 1488638742
        }
    }
}

Request   

GET {api_uri}/appointments/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the appointment. Example: 2

Create Appointment

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/appointments" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointments"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/appointments

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

appointmentStatus   string   

Appointment Status Name Example: New

appointmentTypeId   string   

Appointment Status Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

primaryUserId   string   

Appointment Primary User Id Example: e5c370b3-3b48-11ea-ab87-080027f092e2

start   datetime   

Appointment Start date time Example: 2020-09-01 13:05:00

end   datetime   

Appointment End date time Example: 2020-09-01 14:05:00

instructions   string  optional  

Appointment Instructions Example: This is the appointment instructions

notes   string  optional  

Appointment Notes Example: This is the appointment notes

Update Appointment

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/appointments/2" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointments/2"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/appointments/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the appointment. Example: 2

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

appointmentStatus   string   

Appointment Status Name Example: New

appointmentTypeId   string   

Appointment Status Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

primaryUserId   string   

Appointment Primary User Id Example: e5c370b3-3b48-11ea-ab87-080027f092e2

start   datetime   

Appointment Start date time Example: 2020-09-01 13:05:00

end   datetime   

Appointment End date time Example: 2020-09-01 14:05:00

instructions   string  optional  

Appointment Instructions Example: This is the appointment instructions

notes   string  optional  

Appointment Notes Example: This is the appointment notes

version   integer   

Version number Example: 1543444647

AppointmentType

List AppointmentTypes

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/appointment-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointment-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/appointment-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get AppointmentType

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/appointment-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/appointment-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/appointment-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the appointment type. Example: 1

Attachment

Attachment Status
Published
Obsolete
Hidden

List Attachments

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/attachments" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachments"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/attachments

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Attachment

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/attachments/2" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachments/2"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "attachment",
        "id": "9362cb89-ffb0-4265-88b7-12f1ce20e49d",
        "attributes": {
            "description": "test file",
            "fileName": "test.png",
            "attachmentTypeId": "8cb18cb6-ed8e-3bc2-57a8-15e5076f053f",
            "attachmentStatus": "Published",
            "mimeType": "image/png",
            "size": 181613,
            "url": "https://s3.ap-southeast-2.amazonaws.com/cdn.primeeco.tech/xxx/image1.JPG?uuid=13af40e0-daf4-4b3f-a1bb-74852b6cbf7e&type=thumbnail&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJWI2PN62XOXJO5DQ%2F20220920%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20220920T035317Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Signature=d99f290d43f9bbcf05ba02c9478033d3fbe9408ccf52424f52b95061ed64b920",
            "objectId": "7b7c1013-9c44-9826-f463-920948f89aa0",
            "objectType": "Job"
        }
    }
}

Request   

GET {api_uri}/attachments/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the attachment. Example: 2

Create Attachment

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/attachments" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachments"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/attachments

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
fileName   string   

Attachment name Example: test.png

description   string  optional  

Attachment description Example: This is the attachment description

attachmentTypeId   string   

Attachment Type Id Example: 8cb18cb6-ed8e-3bc2-57a8-15e5076f053f

attachmentStatus   string   

Attachment Status Id Example: Published

objectType   string   

Attachment is linked to a job or contact Example: Job

objectId   string   

Attachment linked job or contact Id Example: 7b7c1013-9c44-9826-f463-920948f89aa0

file   string   

base64 encoded file content Example: deserunt

Update Attachment

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/attachments/2" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachments/2"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/attachments/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the attachment. Example: 2

Body Parameters

attributes   object  optional  
fileName   string   

Attachment name Example: test.png

description   string  optional  

Attachment description Example: This is the attachment description

attachmentTypeId   string   

Attachment Type Id Example: 8cb18cb6-ed8e-3bc2-57a8-15e5076f053f

attachmentStatus   string   

Attachment Status Id Example: Published

AttachmentType

List AttachmentTypes

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/attachment-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachment-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/attachment-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get AttachmentType

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/attachment-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/attachment-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/attachment-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the attachment type. Example: 1

Catastrophe Code

List Catastrophe Codes

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/catastrophe-codes" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/catastrophe-codes

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Catastrophe Code

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/catastrophe-codes/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/catastrophe-codes/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the catastrophe code. Example: 1

Create Catastrophe Code

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "catastropheCode",
        "id": "93c3e652-85a8-4baf-91de-f774184b5334",
        "attributes": {
            "label": "No catastrophe",
            "code": "NO-CAT",
            "version": 1548514578
        }
    }
}

Request   

POST {api_uri}/catastrophe-codes

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
label   string   

Catastrophe Code label Example: No catastrophe

code   string   

Catastrophe Code Example: NO-CAT

Update Catastrophe Code

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/catastrophe-codes/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/catastrophe-codes/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the catastrophe code. Example: 1

Body Parameters

attributes   object  optional  
label   string   

Catastrophe Code label Example: No catastrophe

code   string   

Catastrophe Code Example: NO-CAT

version   integer   

Version number Example: 1543444647

ClientPortal

List ClientPortals

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/client-portals" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/client-portals"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/client-portals

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ClientPortal

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/client-portals/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/client-portals/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/client-portals/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the client portal. Example: 1

Contact

Contact Type
Client
Company
Contact Employee
Contact Office
Customer
Location
Site Contact
Subcontractor
Supplier
User
Payment Term Types
DAYSAFTERBILLDATE
DAYSAFTERBILLMONTH
OFCURRENTMONTH
OFFOLLOWINGMONTH

List Contacts

requires authentication

Filter contacts by type, for example: GET /api/contacts?q='contactType.name'.eq('Client')

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contacts" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contacts"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/contacts

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Contact

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contacts/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contacts/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "contact",
        "id": "ac094821-49fd-ac12-fffb-9398127a8046",
        "attributes": {
            "status": "active",
            "position": "",
            "isIndividual": false,
            "name": "Teds Plumbing",
            "firstName": "",
            "lastName": "",
            "salutation": "",
            "contactType": "Subcontractor",
            "primaryContact": "Ted Logan",
            "homeNumber": "+1-962-866-0751",
            "mobileNumber": "",
            "workNumber": "",
            "preferredContactNumber": "Home",
            "preferredContactNumberValue": "+1-962-866-0751",
            "contactEmail": "paul@primeecosystem.com.au",
            "abn": "4291829310",
            "financeRef": "Ref001",
            "levesysRef": "ABC123",
            "xeroRef": "4269db00-66c4-4d38-a5df-ab0b4f483afe",
            "notes": "Voluptas qui non ad qui hic blanditiis. Laudantium quia sit earum nam ipsum officia. Quas qui tenetur error. Et id provident qui harum.\n\nExcepturi id veritatis inventore cum. Numquam aut numquam saepe culpa similique beatae. Et hic ratione provident veniam. Autem quam molestiae ullam dignissimos voluptas.\n\nCupiditate autem natus et ipsa. Occaecati corrupti omnis explicabo et ipsam. Sed eum inventore ullam ratione sed cupiditate ea.",
            "salesAccountNumber": "200",
            "purchasesAccountNumber": "400",
            "salesPaymentTermType": "DAYSAFTERBILLDATE",
            "salesPaymentTermValue": 12,
            "purchasesPaymentTermType": "DAYSAFTERBILLMONTH",
            "purchasesPaymentTermValue": 15,
            "linkedToContactId": "51ea9438-22fd-8304-77e5-60d95ee4c5c6",
            "address": {
                "addressLine1": "1 Test Street",
                "suburb": "South Tamworth",
                "state": "QLD",
                "country": "Australia",
                "postcode": "2340"
            },
            "postalAddress": {
                "addressLine1": "PO BOX 123",
                "suburb": "South Tamworth",
                "state": "QLD",
                "country": "Australia",
                "postcode": "2340"
            },
            "subcontractor": {
                "gstRegistered": true,
                "contactNumber": "(816) 586-6686",
                "serviceAreas": "",
                "paymentAccountName": "Blanca Doyle",
                "paymentAccountNumber": "513843894089133",
                "paymentAccountBsb": "APTTMS7NM0C"
            },
            "createdAt": "2016-11-19 19:37:17",
            "createdBy": "Test User",
            "updatedAt": "2017-07-29 01:30:10",
            "updatedBy": "Test User",
            "version": 1518499684
        }
    }
}

Request   

GET {api_uri}/contacts/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 1

Create Contact

requires authentication

The subcontractor section is only available for Subcontractor type contact.

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/contacts" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contacts"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/contacts

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
status   string   

Contact status(active or inactive) Example: active

isIndividual   boolean   

Customer is individual or organisation. true for individual and false for organisation Example: true

name   string  optional  

Contact name - required if attributes.isIndividual is false Example: Bob the Builder(hide)

firstName   string  optional  

Contact first name - required if attributes.isIndividual is true Example: John

lastName   string  optional  

Contact last name - required if attributes.isIndividual is true Example: Smith

contactType   string  optional  

Contact type Example: Subcontractor

primaryContact   string  optional  

Primary contact name Example: Bob Jones

homeNumber   string  optional  

Home number Example: 0722224444

mobileNumber   string  optional  

Mobile number Example: 0400111222

workNumber   string  optional  

Work number Example: 0733335555

preferredContactNumber   string   

Preferred Contact Number Type(Home, Mobile, Work) Example: Mobile

contactEmail   email  optional  

Contact email address Example: test@bob.com

abn   string  optional  

ABN Example: 1111111111

acn   string  optional  

ACN Example: 1111111111

position   string  optional  

Contact position Example: Manager

financeRef   string  optional  

Finance reference Example: Ref001

notes   string  optional  

Notes Example: This is some information about the contact

salesPaymentTermType   string  optional  

Sales Payment Term Type Example: DAYSAFTERBILLDATE

salesPaymentTermValue   integer  optional  

Sales Payment Term Value Example: 10

purchasesPaymentTermType   string  optional  

Purchases Payment Term Type Example: OFCURRENTMONTH

purchasesPaymentTermValue   integer  optional  

Purchases Payment Term Value Example: 30

linkedToContactId   string  optional  

Linked to Contact Id, which normally is employer's id Example: 51ea9438-22fd-8304-77e5-60d95ee4c5c6

address   object  optional  
addressLine1   string  optional  

Address line 1 Example: 1 Queen Street

secondarySuburb   sting  optional  

address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Address suburb Example: Brisbane

postcode   string  optional  

Address postcode Example: 4000

state   string  optional  

Address state(For Australia only) Example: QLD

country   string  optional  

Address country Example: Australia

postalSameAsAddress   boolean  optional  

Postal Address is same as Address Example: false

postalAddress   object  optional  
addressLine1   string  optional  

Postal Address line 1 Example: 1 Queen Street

secondarySuburb   sting  optional  

Postal address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Postal Address suburb Example: Brisbane

postcode   string  optional  

Postal Address postcode Example: 4000

state   string  optional  

Postal Address state(For Australia only) Example: QLD

country   string  optional  

Postal Address country Example: Australia

subcontractor   object  optional  
gstRegistered   boolean   

Subcontractor is GST registered Example: true

contactNumber   string  optional  

Subcontractor contact number Example: 0456123456

serviceAreas   string  optional  

Subcontractor service areas Example: South Brisbane,Logan

paymentAccountName   string  optional  

Subcontractor payment account name Example: Bob Jones

paymentAccountNumber   string  optional  

Subcontractor payment account number Example: 8765 1234

paymentAccountBsb   string  optional  

Subcontractor payment account BSB Example: 123456

Update Contact

requires authentication

The subcontractor section is only available for Subcontractor type contact.

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/contacts/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contacts/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/contacts/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 1

Body Parameters

attributes   object  optional  
status   string   

Contact status(active or inactive) Example: active

isIndividual   boolean   

Customer is individual or organisation. true for individual and false for organisation Example: false

name   string  optional  

Contact name required if attributes.isIndividual is false Example: Bob the Builder

firstName   string  optional  

Contact first name required if attributes.isIndividual is true Example: John(hide)

lastName   string  optional  

Contact last name required if attributes.isIndividual is true Example: Smith(hide)

contactType   string  optional  

Contact type Example: Subcontractor

primaryContact   string  optional  

Primary contact name Example: Bob Jones

homeNumber   string  optional  

Home number Example: 0722224444

mobileNumber   string  optional  

Mobile number Example: 0400111222

workNumber   string  optional  

Work number Example: 0733335555

preferredContactNumber   string   

Preferred Contact Number Type(Home, Mobile, Work) Example: Mobile

contactEmail   email  optional  

Contact email address Example: test@bob.com

abn   string  optional  

ABN Example: 1111111111

acn   string  optional  

ACN Example: 1111111111

position   string  optional  

Contact position Example: Manager

financeRef   string  optional  

Finance reference Example: Ref001

notes   string  optional  

Notes Example: This is some information about the contact

salesPaymentTermType   string  optional  

Sales Payment Term Type Example: DAYSAFTERBILLDATE

salesPaymentTermValue   integer  optional  

Sales Payment Term Value Example: 10

purchasesPaymentTermType   string  optional  

Purchases Payment Term Type Example: OFCURRENTMONTH

purchasesPaymentTermValue   integer  optional  

Purchases Payment Term Value Example: 30

linkedToContactId   string  optional  

Linked to Contact Id, which normally is employer's id Example: 51ea9438-22fd-8304-77e5-60d95ee4c5c6

address   object  optional  
addressLine1   string  optional  

Address line 1 Example: 1 Queen Street

secondarySuburb   sting  optional  

address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Address suburb Example: Brisbane

postcode   string  optional  

Address postcode Example: 4000

state   string  optional  

Address state(For Australia only) Example: QLD

country   string  optional  

Address country Example: Australia

postalSameAsAddress   boolean  optional  

Postal Address is same as Address Example: false

postalAddress   object  optional  
addressLine1   string  optional  

Postal Address line 1 Example: 1 Queen Street

secondarySuburb   sting  optional  

Postal address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Postal Address suburb Example: Brisbane

postcode   string  optional  

Postal Address postcode Example: 4000

state   string  optional  

Postal Address state(For Australia only) Example: QLD

country   string  optional  

Postal Address country Example: Australia

subcontractor   object  optional  
gstRegistered   boolean   

Subcontractor is GST registered Example: true

contactNumber   string  optional  

Subcontractor contact number Example: 0456123456

serviceAreas   string  optional  

Subcontractor service areas Example: South Brisbane,Logan

paymentAccountName   string  optional  

Subcontractor payment account name Example: Bob Jones

paymentAccountNumber   string  optional  

Subcontractor payment account number Example: 8765 1234

paymentAccountBsb   string  optional  

Subcontractor payment account BSB Example: 123456

version   integer   

Version number Example: 1543444647

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/contacts/1/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contacts/1/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/contacts/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 1

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

ContactLicence

Contact Licence(Compliance Record)

Licence Status
Active
Pending
Incomplete
Obsolete
Licence Type
Licence
Insurance
Contract
Health & Safety
CM3
WWC
Medical

List ContactLicences

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-licences" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-licences"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/contact-licences

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ContactLicence

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-licences/3" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-licences/3"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "contact-licence",
        "id": "da4741b8-113e-11ed-955f-34c93d5aba49",
        "attributes": {
            "contactId": "048d77e1-cf1a-7452-c892-11d6e3fbe125",
            "licenceStatus": "Active",
            "licenceType": "Insurance",
            "state": null,
            "attachmentId": null,
            "number": "PL2324343",
            "startDate": null,
            "expiryDate": "2018-10-31",
            "label": "Public Liability",
            "notes": null,
            "version": 1524056796
        }
    }
}

Request   

GET {api_uri}/contact-licences/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact licence. Example: 3

Create ContactLicence

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/contact-licences" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-licences"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/contact-licences

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
contactId   string   

Contact Licence Contact Id Example: 048d77e1-cf1a-7452-c892-11d6e3fbe125

licenceStatus   string   

Licence Status Example: Active

licenceType   string   

Licence Type Example: Insurance

state   string  optional  

Licence State Example: false

attachmentId   string  optional  

Attachment Id Example: 54a8d8ea-7d57-632e-58b3-6af88b7cd7f7

number   string  optional  

Licence Number Example: PL134345342

startDate   date  optional  

Licence Start Date Example: 2020-02-01

expiryDate   date  optional  

Licence Expiry Date Example: 2022-02-01

label   string  optional  

Licence Label Example: Public Liability

notes   string  optional  

Licence Notes Example: test

Update ContactLicence

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/contact-licences/3" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-licences/3"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/contact-licences/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact licence. Example: 3

Body Parameters

attributes   object  optional  
contactId   string   

Contact Licence Contact Id Example: 048d77e1-cf1a-7452-c892-11d6e3fbe125

licenceStatus   string   

Licence Status Example: Active

licenceType   string   

Licence Type Example: Insurance

state   string  optional  

Licence State Example: false

attachmentId   string  optional  

Attachment Id Example: 54a8d8ea-7d57-632e-58b3-6af88b7cd7f7

number   string  optional  

Licence Number Example: PL134345342

startDate   date  optional  

Licence Start Date Example: 2020-02-01

expiryDate   date  optional  

Licence Expiry Date Example: 2022-02-01

label   string  optional  

Licence Label Example: Public Liability

notes   string  optional  

Licence Notes Example: test

version   integer   

Version number Example: 1543444647

ContactRelationshipType

List ContactRelationshipTypes

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-relationship-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationship-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/contact-relationship-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ContactRelationshipType

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-relationship-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationship-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/contact-relationship-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact relationship type. Example: 1

CustomField

type
text
multitext
select
multiselect
boolean
currency
date
signature
time

List CustomFields

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/custom-fields" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/custom-fields"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/custom-fields

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get CustomField

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/custom-fields/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/custom-fields/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "customField",
        "id": "dfe21559-c86c-63cc-37bb-6f2725fea501",
        "attributes": {
            "customFieldType": "job",
            "type": "text",
            "name": "age-of-property",
            "label": "Age of Property",
            "description": "Age of Property",
            "version": 1491907589
        }
    }
}

Request   

GET {api_uri}/custom-fields/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the custom field. Example: 1

CustomFieldOption

List CustomFieldOptions

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/custom-field-options" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/custom-field-options"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/custom-field-options

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get CustomFieldOption

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/custom-field-options/7" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/custom-field-options/7"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/custom-field-options/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the custom field option. Example: 7

Division

List Divisions

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/divisions" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/divisions"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/divisions

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Division

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/divisions/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/divisions/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/divisions/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the division. Example: 1

Create Division

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/divisions" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/divisions"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/divisions

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
name   string   

Division name Example: Insurance

description   string  optional  

Division description Example: This is the division description

emailSignature   string  optional  

Division user email signature Example: <p>Kind regards,<br /><strong><em>[user-name]<br /></em></strong><strong>[user-position]</strong></p>

Update Division

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/divisions/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/divisions/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/divisions/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the division. Example: 1

Body Parameters

attributes   object  optional  
name   string   

Division name Example: Insurance

description   string  optional  

Division description Example: This is the division description

emailSignature   string  optional  

Division user email signature Example: <p>Kind regards,<br /><strong><em>[user-name]<br /></em></strong><strong>[user-position]</strong></p>

version   integer   

Version number Example: 1543444647

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/divisions/1/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/divisions/1/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/divisions/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the division. Example: 1

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

Estimate

Estimate Types
Authorised Works
Direct Allocation

List Locked Estimates

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimates-snapshot" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates-snapshot"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimates-snapshot

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Locked Estimate

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimates-snapshot/eum" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates-snapshot/eum"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
   "data": {
       "type": "estimateSnapshot",
       "id": "9d91f5f6-4529-c3cb-f0a4-8186df946faf",
       "attributes": {
           "jobId": "b6d87e29-98e5-3f8d-4a3e-eaa15ca0d212",
           "label": "Estimate",
           "description": "Estimate",
           "estimateStatus": "Authorised",
           "isVariation": 0,
           "estimateType": "Authorised Works",
           "totalIncludingTax": 78292.5,
           "authorisedTotalExcludingTax": 71175,
           "authorisedTotalIncludingTax": 78292.5,
           "estimateCategories": [
               {
                   "id": "7faaf2e8-101e-3444-19de-1635b402b2ff",
                   "type": "preliminary",
                   "label": "Preliminaries",
                   "description": null,
                   "materialMargin": "0.000000",
                   "labourMargin": "0.000000",
                   "estimateItems": [
                       {
                           "id": "96358720-76d8-4898-7cad-18bf8a4737a9",
                           "authorised": 1,
                           "trade": null,
                           "description": "Supervison",
                           "materialUnit": "ea",
                           "materialQuantity": "0.00",
                           "materialCost": "0.00",
                           "materialTotal": "0.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "23.00",
                           "labourCost": "23.00",
                           "labourTotal": "529.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "075fadcb-6161-e717-ed53-da60cc0dee08",
                           "authorised": 1,
                           "trade": null,
                           "description": "Waste Management",
                           "materialUnit": "ea",
                           "materialQuantity": "0.00",
                           "materialCost": "0.00",
                           "materialTotal": "0.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "231.00",
                           "labourCost": "23.00",
                           "labourTotal": "5313.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       }
                   ]
               },
               {
                   "id": "bc628fa9-3082-227f-8ba8-ae64a82c328f",
                   "type": "category",
                   "label": "Bedroom",
                   "description": null,
                   "materialMargin": "0.000000",
                   "labourMargin": "0.000000",
                   "estimateItems": [
                       {
                           "id": "fc0cd926-bc46-8f44-2b8c-ae28c114597e",
                           "authorised": 1,
                           "trade": "Floor Covers",
                           "description": "asdfadsfadsfasdf",
                           "materialUnit": "ea",
                           "materialQuantity": "132.00",
                           "materialCost": "34.00",
                           "materialTotal": "4488.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "232.00",
                           "labourCost": "23.00",
                           "labourTotal": "5336.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "f6561ad4-2957-db56-ad7e-eece7cf27daf",
                           "authorised": 1,
                           "trade": "Roof Tiling",
                           "description": "asfdasdfasdfasdf",
                           "materialUnit": "ea",
                           "materialQuantity": "4.00",
                           "materialCost": "4.00",
                           "materialTotal": "16.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "14.00",
                           "labourCost": "3434.00",
                           "labourTotal": "48076.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "d7fcb71b-ed41-9f9e-0b87-55ca8ef2a677",
                           "authorised": 1,
                           "trade": "Roof Tiling",
                           "description": "asfasdfasdfasdf",
                           "materialUnit": "ea",
                           "materialQuantity": "41.00",
                           "materialCost": "34.00",
                           "materialTotal": "1394.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "41.00",
                           "labourCost": "23.00",
                           "labourTotal": "943.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "e12c7bb0-7ae3-8ddb-e68a-a19e2416bd6a",
                           "authorised": 1,
                           "trade": "Roof Tiling",
                           "description": "asfdadsfasdfasdfasd",
                           "materialUnit": "ea",
                           "materialQuantity": "14.00",
                           "materialCost": "34.00",
                           "materialTotal": "476.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "14.00",
                           "labourCost": "23.00",
                           "labourTotal": "322.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       }
                   ]
               },
               {
                   "id": "d1d5ceea-5702-2dd2-4cd0-6fe41ce18654",
                   "type": "category",
                   "label": "Kitchen",
                   "description": null,
                   "materialMargin": "0.000000",
                   "labourMargin": "0.000000",
                   "estimateItems": [
                       {
                           "id": "224fa004-294c-d156-6d9b-cfe634cc275a",
                           "authorised": 1,
                           "trade": "Automatic Gates",
                           "description": "asdfdsfdsfdsaf",
                           "materialUnit": "ea",
                           "materialQuantity": "331.00",
                           "materialCost": "4.00",
                           "materialTotal": "1324.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "14.00",
                           "labourCost": "3.00",
                           "labourTotal": "42.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "885e4176-acda-aad5-6716-21045088894c",
                           "authorised": 1,
                           "trade": "Automatic Gates",
                           "description": "asdfasdfasdf",
                           "materialUnit": "ea",
                           "materialQuantity": "31.00",
                           "materialCost": "34.00",
                           "materialTotal": "1054.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "41.00",
                           "labourCost": "34.00",
                           "labourTotal": "1394.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       },
                       {
                           "id": "75ef78d0-be2e-296f-6d24-d06566650c0c",
                           "authorised": 1,
                           "trade": "Automatic Gates",
                           "description": "asdfasdfasdfasfd",
                           "materialUnit": "ea",
                           "materialQuantity": "13.00",
                           "materialCost": "32.00",
                           "materialTotal": "416.00",
                           "materialMarkup": "0.000000",
                           "materialMarkupTotal": "0.00",
                           "labourUnit": "ea",
                           "labourQuantity": "13.00",
                           "labourCost": "4.00",
                           "labourTotal": "52.00",
                           "labourMarkup": "0.000000",
                           "labourMarkupTotal": "0.00",
                           "tax": "0.10",
                           "materialMargin": "0.000000",
                           "labourMargin": "0.000000"
                           "additionalMargin": "0.000000"
                       }
                   ]
               }
           ],
           "filterTags": [],
            "createdAt": "2016-12-01 09:03:58",
           "createdBy": "Paul Brandis",
           "updatedAt": "2016-12-01 09:04:02",
           "updatedBy": "Paul Brandis",
           "version": 1480547042
       }
   }
}

Request   

GET {api_uri}/estimates-snapshot/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the estimates snapshot. Example: eum

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/estimates-snapshot/vitae/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates-snapshot/vitae/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/estimates-snapshot/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the estimates snapshot. Example: vitae

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

List Unlocked Estimates

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimates" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimates

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Unlocked Estimate

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimates/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "estimate",
        "id": "9d91f5f6-4529-c3cb-f0a4-8186df946faf",
        "attributes": {
            "jobId": "b6d87e29-98e5-3f8d-4a3e-eaa15ca0d212",
            "label": "Estimate",
            "description": "Estimate",
            "estimateStatus": "Pending",
            "isVariation": 0,
            "estimateType": "Authorised Works",
            "totalIncludingTax": 78292.5,
            "assignedId": "453948d0-5dcb-3b1a-628e-60635f7b03e5",
            "estimateCategories": [
                {
                    "id": "7faaf2e8-101e-3444-19de-1635b402b2ff",
                    "type": "preliminary",
                    "label": "Preliminaries",
                    "description": null,
                    "materialMargin": "0.000000",
                    "labourMargin": "0.000000",
                    "estimateItems": [
                        {
                            "id": "96358720-76d8-4898-7cad-18bf8a4737a9",
                            "authorised": 0,
                            "trade": null,
                            "description": "Supervison",
                            "materialUnit": "ea",
                            "materialQuantity": "0.00",
                            "materialCost": "0.00",
                            "materialTotal": "0.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "23.00",
                            "labourCost": "23.00",
                            "labourTotal": "529.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "075fadcb-6161-e717-ed53-da60cc0dee08",
                            "authorised": 0,
                            "trade": null,
                            "description": "Waste Management",
                            "materialUnit": "ea",
                            "materialQuantity": "0.00",
                            "materialCost": "0.00",
                            "materialTotal": "0.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "231.00",
                            "labourCost": "23.00",
                            "labourTotal": "5313.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        }
                    ]
                },
                {
                    "id": "bc628fa9-3082-227f-8ba8-ae64a82c328f",
                    "type": "category",
                    "label": "Bedroom",
                    "description": null,
                    "materialMargin": "0.000000",
                    "labourMargin": "0.000000",
                    "estimateItems": [
                        {
                            "id": "fc0cd926-bc46-8f44-2b8c-ae28c114597e",
                            "authorised": 0,
                            "trade": "Floor Covers",
                            "description": "asdfadsfadsfasdf",
                            "materialUnit": "ea",
                            "materialQuantity": "132.00",
                            "materialCost": "34.00",
                            "materialTotal": "4488.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "232.00",
                            "labourCost": "23.00",
                            "labourTotal": "5336.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "f6561ad4-2957-db56-ad7e-eece7cf27daf",
                            "authorised": 0,
                            "trade": "Roof Tiling",
                            "description": "asfdasdfasdfasdf",
                            "materialUnit": "ea",
                            "materialQuantity": "4.00",
                            "materialCost": "4.00",
                            "materialTotal": "16.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "14.00",
                            "labourCost": "3434.00",
                            "labourTotal": "48076.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "d7fcb71b-ed41-9f9e-0b87-55ca8ef2a677",
                            "authorised": 0,
                            "trade": "Roof Tiling",
                            "description": "asfasdfasdfasdf",
                            "materialUnit": "ea",
                            "materialQuantity": "41.00",
                            "materialCost": "34.00",
                            "materialTotal": "1394.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "41.00",
                            "labourCost": "23.00",
                            "labourTotal": "943.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "e12c7bb0-7ae3-8ddb-e68a-a19e2416bd6a",
                            "authorised": 0,
                            "trade": "Roof Tiling",
                            "description": "asfdadsfasdfasdfasd",
                            "materialUnit": "ea",
                            "materialQuantity": "14.00",
                            "materialCost": "34.00",
                            "materialTotal": "476.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "14.00",
                            "labourCost": "23.00",
                            "labourTotal": "322.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        }
                    ]
                },
                {
                    "id": "d1d5ceea-5702-2dd2-4cd0-6fe41ce18654",
                    "type": "category",
                    "label": "Kitchen",
                    "description": null,
                    "materialMargin": "0.000000",
                    "labourMargin": "0.000000",
                    "estimateItems": [
                        {
                            "id": "224fa004-294c-d156-6d9b-cfe634cc275a",
                            "authorised": 0,
                            "trade": "Automatic Gates",
                            "description": "asdfdsfdsfdsaf",
                            "materialUnit": "ea",
                            "materialQuantity": "331.00",
                            "materialCost": "4.00",
                            "materialTotal": "1324.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "14.00",
                            "labourCost": "3.00",
                            "labourTotal": "42.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "885e4176-acda-aad5-6716-21045088894c",
                            "authorised": 0,
                            "trade": "Automatic Gates",
                            "description": "asdfasdfasdf",
                            "materialUnit": "ea",
                            "materialQuantity": "31.00",
                            "materialCost": "34.00",
                            "materialTotal": "1054.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "41.00",
                            "labourCost": "34.00",
                            "labourTotal": "1394.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        },
                        {
                            "id": "75ef78d0-be2e-296f-6d24-d06566650c0c",
                            "authorised": 0,
                            "trade": "Automatic Gates",
                            "description": "asdfasdfasdfasfd",
                            "materialUnit": "ea",
                            "materialQuantity": "13.00",
                            "materialCost": "32.00",
                            "materialTotal": "416.00",
                            "materialMarkup": "0.000000",
                            "materialMarkupTotal": "0.00",
                            "labourUnit": "ea",
                            "labourQuantity": "13.00",
                            "labourCost": "4.00",
                            "labourTotal": "52.00",
                            "labourMarkup": "0.000000",
                            "labourMarkupTotal": "0.00",
                            "tax": "0.10",
                            "materialMargin": "0.000000",
                            "labourMargin": "0.000000"
                        }
                    ]
                }
            ],
            "filterTags": [],
            "createdAt": "2016-12-01 09:03:58",
            "createdBy": "Paul Brandis",
            "updatedAt": "2016-12-01 09:04:02",
            "updatedBy": "Paul Brandis",
            "version": 1480547042
        }
    }
}

Request   

GET {api_uri}/estimates/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate. Example: 14

Create Estimate

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/estimates" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/estimates

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
label   string   

Estimate name Example: Estimate 1

description   string  optional  

Estimate description Example: This is the estimate description

jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

assignedId   string  optional  

Assigned Contact Id(User Type only) Example: 130d48d7-0347-cf56-f28f-335bf018c0e0

estimateType   string   

Estimate Type Example: Authorised Works

Update Estimate

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/estimates/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/estimates/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate. Example: 14

Body Parameters

attributes   object  optional  
label   string   

Estimate name Example: Estimate 1

description   string  optional  

Estimate description Example: This is the estimate description

jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

assignedId   string  optional  

Assigned Contact Id(User Type only) Example: 130d48d7-0347-cf56-f28f-335bf018c0e0

estimateType   string   

Estimate Type Example: Authorised Works

version   integer   

Version number Example: 1543444647

Delete Estimate

requires authentication

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/estimates/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/estimates/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate. Example: 14

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/estimates/14/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimates/14/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/estimates/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate. Example: 14

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

EstimateCategory

Estimate CategoryTypes
category
preliminary
insurance
areaUnit
m
cm
mm
ft

List Estimate Categories

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimate-categories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimate-categories

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Estimate Category

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimate-categories/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimate-categories/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate category. Example: 14

Create Estimate Category

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/estimate-categories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/estimate-categories

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
label   string   

Estimate name Example: Estimate 1

description   string  optional  

Estimate description Example: This is the estimate description

estimateId   string   

Estimate Id Example: 996b00ee-0756-46f5-a21e-0117219a94c3

type   string  optional  

Estimate Category Type - default value is category Example: category

useSuppliedMargins   boolean  optional  

Override the default materialMargin and labourMargin values - default value is false Example: true

materialMargin   decimal  optional  

Estimate Category Material Margin Example: 0.2

labourMargin   decimal  optional  

Estimate Category Labour Margin Example: 0.2

length   decimal  optional  

Room Area Length Example: 4

width   decimal  optional  

Room Area Width Example: 3

height   decimal  optional  

Room Area Height Example: 2.4

areaUnit   string  optional  

Room Area Unit Example: m

Update Estimate Category

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/estimate-categories/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate category. Example: 14

Body Parameters

attributes   object  optional  
label   string   

Estimate name Example: Estimate 1

description   string  optional  

Estimate description Example: This is the estimate description

estimateId   string   

Estimate Id Example: 996b00ee-0756-46f5-a21e-0117219a94c3

type   string  optional  

Estimate Category Type - default value is category Example: category

materialMargin   decimal  optional  

Estimate Category Material Margin Example: 0.2

labourMargin   decimal  optional  

Estimate Category Labour Margin Example: 0.2

length   decimal  optional  

Room Area Length Example: 4

width   decimal  optional  

Room Area Width Example: 3

height   decimal  optional  

Room Area Height Example: 2.4

areaUnit   string  optional  

Room Area Unit Example: m

version   integer   

Version number Example: 1543444647

Delete Estimate Category

requires authentication

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/estimate-categories/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate category. Example: 14

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-categories/14/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/estimate-categories/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate category. Example: 14

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

EstimateItem

Estimate Item Type
Prime Costs
Provisional Sum

List Estimate Items

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimate-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimate-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Estimate Item

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/estimate-items/41" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-items/41"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/estimate-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate item. Example: 41

Create Estimate Item

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/estimate-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/estimate-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
description   string   

Estimate Item description Example: Item 1

notes   string  optional  

Estimate Item notes Example: This is the estimate item notes

estimateId   string   

Estimate Id Example: 996b00ee-0756-46f5-a21e-0117219a94c3

estimateCategoryId   string   

Estimate Category Id Example: ab531dd3-1379-47f7-93a8-fda6e1e51b20

tradeId   string   

Trade Id Example: 59d47247-6ee4-11ec-81d3-34c93d5aba49

estimateItemType   string  optional  

Estimate Item Type Example: Provisional Sum

noTax   boolean  optional  

Indicate the item is Tax Free or not - default value is false Example: true

materialUnitId   string  optional  

Material Unit Id Example: 59dd3df2-6ee4-11ec-81d3-34c93d5aba49

materialQuantity   decimal  optional  

Material Quantity Example: 5

materialCost   decimal  optional  

Material Cost Example: 20

materialMarkup   decimal  optional  

Material Markup Example: 0.2

labourUnitId   string  optional  

Labour Unit Id Example: 59dd7d8f-6ee4-11ec-81d3-34c93d5aba49

labourQuantity   decimal  optional  

Labour Quantity Example: 2

labourCost   decimal  optional  

Labour Cost Example: 50

labourMarkup   decimal  optional  

Labour Markup Example: 0.3

Update Estimate Item

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/estimate-items/41" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-items/41"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/estimate-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate item. Example: 41

Body Parameters

attributes   object  optional  
description   string   

Estimate Item description Example: Item 1

notes   string  optional  

Estimate Item notes Example: This is the estimate item notes

estimateId   string   

Estimate Id Example: 996b00ee-0756-46f5-a21e-0117219a94c3

estimateCategoryId   string   

Estimate Category Id Example: ab531dd3-1379-47f7-93a8-fda6e1e51b20

tradeId   string   

Trade Id Example: 59d47247-6ee4-11ec-81d3-34c93d5aba49

estimateItemType   string  optional  

Estimate Item Type Example: Provisional Sum

noTax   boolean  optional  

Indicate the item is Tax Free or not - default value is false Example: true

materialUnitId   string  optional  

Material Unit Id Example: 59dd3df2-6ee4-11ec-81d3-34c93d5aba49

materialQuantity   decimal  optional  

Material Quantity Example: 5

materialCost   decimal  optional  

Material Cost Example: 20

materialMarkup   decimal  optional  

Material Markup Example: 0.2

labourUnitId   string  optional  

Labour Unit Id Example: 59dd7d8f-6ee4-11ec-81d3-34c93d5aba49

labourQuantity   decimal  optional  

Labour Quantity Example: 2

labourCost   decimal  optional  

Labour Cost Example: 50

labourMarkup   decimal  optional  

Labour Markup Example: 0.3

version   integer   

Version number Example: 1543444647

Delete Estimate Item

requires authentication

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/estimate-items/41" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/estimate-items/41"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/estimate-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the estimate item. Example: 41

Feedback Item

List Feedback Items

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/feedback-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Feedback Item

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-items/ipsam" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-items/ipsam"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "feedback-item",
        "id": "42ba137d-fe18-11ee-8e31-0a002700000b",
        "attributes": {
            "jobId": "9018792c-bf58-4621-93e0-77097b5d0f08",
            "feedbackItemTypeId": "42c9ff6e-fe18-11ee-8e31-0a002700000b",
            "feedbackItemStatusId": "42df206a-fe18-11ee-8e31-0a002700000b",
            "feedbackItemSubmissionTypeId": null,
            "description": "This is my complaint",
            "shortDescription": "This is my complaint",
            "loggedById": "cf285faf-4b32-4959-a896-5297eacc0bcf",
            "loggedByName": "360 Personnel",
            "assignedId": null,
            "linkedContactId": null,
            "linkedContactName": null,
            "incidentAt": "2022-05-13 02:04:47",
            "resolvedAt": "",
            "notes": "tresting",
            "hasCost": 0,
            "costTotal": null,
            "notifiedTypeId": null,
            "notifiedById": null,
            "notified": 0,
            "notifiedAt": "",
            "targetResolutionDate": "2023-09-19",
            "nextReviewDate": "2023-09-20",
            "createdAt": "2023-05-08 14:57:01",
            "createdBy": "Ian Johns",
            "updatedAt": "2023-11-08 14:49:22",
            "updatedBy": "Ian Johns",
            "createdDurationMilliseconds": 159676580,
            "updatedDurationMilliseconds": 158552580,
            "version": 1699418962
        }
    }
}

Request   

GET {api_uri}/feedback-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the feedback item. Example: ipsam

Create Feedback Item

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/feedback-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/feedback-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

feedbackItemTypeId   string   

Feedback Item Type Id Example: aab2eef6-69f0-11ec-81d3-34c93d5aba49

feedbackItemStatusId   string   

Feedback Item Status Id Example: aaac102f-69f0-11ec-81d3-34c93d5aba49

feedbackItemSubmissionTypeId   string  optional  

Feedback Item Submission Type Id Example: 42ec8fd7-fe18-11ee-8e31-0a002700000b

description   string   

Description Example: This is my complaint

loggedById   string   

Logged By Id Example: 022ab15c-d5e3-7334-3099-8dac1a6ccf2f

assignedId   string  optional  

Assigned to user id Example: 8cd011c4-ddbe-cd4c-e60c-b09e301fb37d

linkedContactId   string  optional  

Linked Contact Id Example: 749dc1ba-a07a-c146-58a8-3105ce7244b1

incidentAt   datetime   

Incident At Example: 2022-01-03 07:50:00

resolvedAt   datetime  optional  

Feedback Resolved At Example: 2022-01-03 07:50:00

notes   string  optional  

Notes Example: Resolve notes

hasCost   boolean   

Whether cost involved in sloving the issue Example: true

costTotal   decimal  optional  

Cost Total Example: 100.00

notified   boolean   

Whether notfied contact the result of the feedback Example: true

notifiedTypeId   string  optional  

Notified Type Id Example: 42ec8fd7-fe18-11ee-8e31-0a002700000b

notifiedById   string  optional  

Notifyed By Id Example: 8cd011c4-ddbe-cd4c-e60c-b09e301fb37d

notifiedAt   datetime  optional  

Notified At Example: 2022-02-03 07:50:00

targetResolutionDate   date  optional  

Target Resolution Date Example: 2022-02-03

nextReviewDate   date  optional  

Next Review Date Example: 2022-02-03

Update Feedback Item

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/feedback-items/cum" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-items/cum"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/feedback-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the feedback item. Example: cum

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

feedbackItemTypeId   string   

Feedback Item Type Id Example: aab2eef6-69f0-11ec-81d3-34c93d5aba49

feedbackItemStatusId   string   

Feedback Item Status Id Example: aaac102f-69f0-11ec-81d3-34c93d5aba49

feedbackItemSubmissionTypeId   string  optional  

Feedback Item Submission Type Id Example: 42ec8fd7-fe18-11ee-8e31-0a002700000b

description   string   

Description Example: This is my complaint

loggedById   string   

Logged By Id Example: 022ab15c-d5e3-7334-3099-8dac1a6ccf2f

assignedId   string  optional  

Assigned to user id Example: 8cd011c4-ddbe-cd4c-e60c-b09e301fb37d

linkedContactId   string  optional  

Linked Contact Id Example: 749dc1ba-a07a-c146-58a8-3105ce7244b1

incidentAt   datetime   

Incident At Example: 2022-01-03 07:50:00

resolvedAt   datetime  optional  

Feedback Resolved At Example: 2022-01-03 07:50:00

notes   string  optional  

Notes Example: Resolve notes

hasCost   boolean   

Whether cost involved in sloving the issue Example: true

costTotal   decimal  optional  

Cost Total Example: 100.00

notified   boolean   

Whether notfied contact the result of the feedback Example: true

notifiedTypeId   string  optional  

Notified Type Id Example: 42ec8fd7-fe18-11ee-8e31-0a002700000b

notifiedById   string  optional  

Notifyed By Id Example: 8cd011c4-ddbe-cd4c-e60c-b09e301fb37d

notifiedAt   datetime  optional  

Notified At Example: 2022-02-03 07:50:00

targetResolutionDate   date  optional  

Target Resolution Date Example: 2022-02-03

nextReviewDate   date  optional  

Next Review Date Example: 2022-02-03

version   integer   

Version number Example: 1543444647

Feedback Item Status

List Feedback Item Statuses

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-statuses" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-statuses"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/feedback-item-statuses

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Feedback Item Status

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-statuses/eos" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-statuses/eos"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "feedback-item-status",
        "id": "42df543f-fe18-11ee-8e31-0a002700000b",
        "attributes": {
            "name": "closed",
            "label": "Closed",
            "isClosedStatus": true,
            "version": 0
        }
    }
}

Request   

GET {api_uri}/feedback-item-statuses/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the feedback item status. Example: eos

Feedback Item Submission Type

List Feedback Item Submission Types

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-submission-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-submission-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/feedback-item-submission-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Feedback Item Submission Type

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-submission-types/repudiandae" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-submission-types/repudiandae"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "feedback-item-submission-type",
        "id": "42ec8fd7-fe18-11ee-8e31-0a002700000b",
        "attributes": {
            "name": "on-site",
            "label": "On Site",
            "active": 1,
            "version": 0
        }
    }
}

Request   

GET {api_uri}/feedback-item-submission-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the feedback item submission type. Example: repudiandae

Feedback Item Type

List Feedback Item Types

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/feedback-item-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Feedback Item Type

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/feedback-item-types/aperiam" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/feedback-item-types/aperiam"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "feedback-item-type",
        "id": "42c9ff6e-fe18-11ee-8e31-0a002700000b",
        "attributes": {
            "name": "complaint",
            "label": "Complaint",
            "active": 1,
            "version": 0
        }
    }
}

Request   

GET {api_uri}/feedback-item-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the feedback item type. Example: aperiam

FilterTag

List FilterTags

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/filter-tags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/filter-tags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/filter-tags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get FilterTag

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/filter-tags/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/filter-tags/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/filter-tags/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the filter tag. Example: 1

FilterType

List FilterTypes

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/filter-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/filter-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/filter-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get FilterType

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/filter-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/filter-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/filter-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the filter type. Example: 1

Job

Job Type
Assessment
Design
Desktop Assessment
Direct Works
Do and Charge
Fast Track
Job
Liability Quote
Makesafe
Quick Repair
Quote
Quote and Report
Rectification
Report Only
Restoration
Scope and Repair
Scope and Report
Specialist
Straight to Builder

List Jobs

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/jobs" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/jobs

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Job

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/jobs/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "job",
        "id": "a9a3e778-14d3-3434-0690-27bf0099a5ec",
        "attributes": {
            "jobNumber": "DC0000009",
            "clientReference": "TVOZPV1D",
            "additionalReference": "123",
            "description": "Rerum rem consequuntur ut maxime. In architecto labore odit temporibus voluptas officiis in voluptas. Sunt aut nulla similique non voluptate at.",
            "interestedParties": null,
            "divisionId": "30f895a2-9f57-d025-edf0-5b9e95659648",
            "perilId": "12e4d7f0-0d6e-060e-ffdb-58f6de311313",
            "catastropheCodeId": "b1451eb0-3c6d-5e64-f23e-5b99d909900f",
            "jobType": "Quote Override",
            "workflowId": "5f516fc3-0674-e658-89b4-2a49f9854dd1",
            "statusId": "0fe19d75-177e-5445-c04d-a75d2ff3f4a5",
            "address": {
                "addressLine1": "1 Test Street",
                "suburb": "Spring Hill",
                "state": "QLD",
                "country": "Australia",
                "postcode": "4000"
            },
            "customerId": "36546c2d-2b2f-860e-a356-f996986423a3",
            "clientId": "544853af-742d-5144-9d0f-4ee0adaf8f50",
            "assignedId": "948a65ff-145e-1e92-a66e-b2578df51dcf",
            "excessAmount": "200.00",
            "caseManagerId": null,
            "supervisorId": null,
            "primaryContactId": "36546c2d-2b2f-860e-a356-f996986423a3",
            "notes": null,
            "authorisedTotalExcludingTax": 1000,
            "authorisedTotalIncludingTax": 1100,
            "authorisedTotalExcludingTaxExcludingMargin": 800,
            "authorisedTotalExcludingTaxExcludingMarginExcludingMarkup": 750,
            "createdAt": "2016-11-19 19:37:20",
            "filterTags": [
                "Big Job",
                "Building"
            ],
            "region": "Western Sydney",
            "incidentDate": "2016-11-10",
            "allocatedDate": "2016-11-19 19:37:20",
            "brokerReference": null,
            "strataReference": null,
            "adjusterReference": null,
            "primeUrl": "https://primeeco.tech/prime/job/view/CBE",
            "createdBy": "Paul Miller",
            "updatedAt": "2019-01-25 23:39:03",
            "updatedBy": "Adam Brown",
            "version": 1548423543
        }
    },
    "included": [ // example: include=additionalFields&fields=reserveItemSumInsuredTotal,reserveItemOutstandingReserveTotal
         {
             "type": "additionalFields",
             "id": "13e9701c-9df1-4729-9b79-0ca82dabdd6a",
             "attributes": {
                 "version": 1721692517,
                 "reserveItemSumInsuredTotal": "10000.00",
                 "reserveItemOutstandingReserveTotal": "12617.67"
             }
         }
     ]
}

Request   

GET {api_uri}/jobs/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Query Parameters

includes   string  optional  

Add related data additionalFields

fields   string  optional  

Add include=additionalFields and one or more comma separated values

Fields
reserveItemSumInsuredTotal
reserveItemInitialReserveTotal
reserveItemCurrentReserveTotal
reserveItemCurrentReserveNetTotal
reserveItemExcessTotal
reserveItemAuthorisedTotal
reserveItemOutstandingReserveTotal
reserveItemPaidPaymentsTotal
firstCustomerContactCreatedAt
lastCustomerContactCreatedAt
firstClientContactCreatedAt
lastClientContactCreatedAt
lastClientContactNote

Get Job Reserve Item Transactions

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/jobs/1/reserve-transactions" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/reserve-transactions"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": "518c03a7-f29c-4411-8dca-9559c16b89cb",
        "attributes": {
            "jobId": "e2ae1c76-a30c-4e81-9707-00dfa7aa353c",
            "reserveCategoryId": "1ff9f165-0288-4848-8816-178ef90996a0",
            "reserveCategoryLabel": "Strata - Section 4 - Fidelity Guarantee",
            "reserveItemId": "43410300-25b2-46fe-a863-2ddc9bd09c86",
            "actionAt": "2024-05-13 17:52:15",
            "actionBy": "Paul Brandis",
            "actionById": "6ae240d6-1a0f-44ba-a6c3-8b070be48555",
            "actionLabel": "Initial Reserve",
            "adjustmentTotal": null,
            "initialReserveTotal": "800.00",
            "excessTotal": 0,
            "currentReserveTotal": 800,
            "paidPaymentsTotal": 0,
            "outstandingReserveTotal": 800
        }
    },
    {
        "id": "7a6ed9f6-ba77-43b4-bcaf-227b77e701d9",
        "attributes": {
            "jobId": "e2ae1c76-a30c-4e81-9707-00dfa7aa353c",
            "reserveCategoryId": "41e67e0b-6d78-424d-9a0a-4161d6d6fd9b",
            "reserveCategoryLabel": "Strata - Section 6 - Machinery Breakdown",
            "reserveItemId": "a53cf04f-0ca9-43d1-a6d2-5d4495ea9b8b",
            "actionAt": "2024-05-13 17:52:16",
            "actionBy": "Lisa Zhang",
            "actionById": "6ae240d6-1a0f-44ba-a6c3-8b070be48555",
            "actionLabel": "Reserve Update",
            "adjustmentTotal": 5000,
            "initialReserveTotal": null,
            "excessTotal": null,
            "currentReserveTotal": 5800,
            "paidPaymentsTotal": 0,
            "outstandingReserveTotal": 5800
        }
    }
]

Request   

GET {api_uri}/jobs/{id}/reserve-transactions

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Create Job

requires authentication

New customer can be created at the same time.

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/jobs" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/jobs

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobNumber   string  optional  

Job number - required if auto job numbering has been enabled for current company *only available for creating new job Example: DC00001

clientReference   string   

Job client reference Example: AXB123

additionalReference   string  optional  

Job additional reference Example: AA00012

description   string  optional  

Job description Example: This is Job Description

divisionId   string  optional  

Job division id Example: 4653a4bc-6c57-4845-8ae9-9308a63baa25

jobType   string   

Job type Example: Quote

workflowId   string   

Job workflow id Example: 7d730fe6-dd16-49d0-b033-04dccfc7b9f0

statusId   string   

Job status id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07e

perilId   string  optional  

Job peril id Example: c99a2efe-088c-4c3a-a2b6-c26d1de0be39

catastropheCodeId   string  optional  

Job catastrophe code id Example: 4729e1d4-9dbc-49cb-9c5e-bcab8ff798ea

customerId   string  optional  

Job customer(contact) id - required if the customer section is not presented Example: 8566eb93-a1ea-4969-98e4-3502c8bcd422

clientId   string   

Job client(contact) id Example: accbc68e-dd7d-4234-a1f9-48a551b41702

assignedId   string  optional  

Job assigned(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

caseManagerId   string  optional  

Job Case Manager(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

supervisorId   string  optional  

Job Supervisor(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

estimatorId   string  optional  

Job Estimator(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

notes   string  optional  

Job notes Example: This is some job notes

excessAmount   numeric  optional  

Job excess amount Example: 500.00

primaryContactId   string  optional  

Job primary contact id Example: 10afcc68-2165-4706-a359-aa4654d48e91

businessId   string  optional  

Job Business(Company) id Example: dbe4141a-5bb3-8fb2-e8fb-2dc9cbdfa5b9

clientPortalId   string  optional  

Job Client Portal id Example: 0619eb17-73f4-11ef-8a1a-00fff7b445c2

incidentDate   date  optional  

Incident date Example: 2020-12-01

allocatedDate   datetime  optional  

Allocated date Example: 2020-12-01 16:40:00

brokerReference   string  optional  

Broker reference Example: ABC001

strataReference   string  optional  

Strata reference Example: ABC002

adjusterReference   string  optional  

Adjuster reference Example: ABC003

customer   object  optional  
isIndividual   boolean   

Customer is individual or organisation. true for individual and false for organisation Example: true

name   string  optional  

Customer name - required if attributes.customer.isIndividual is 0 Example: Bob the Builder(hide)

firstName   string  optional  

Customer first name - required if attributes.customer.isIndividual is 1 Example: Bob

lastName   string  optional  

Customer last name - required if attributes.customer.isIndividual is 1 Example: Dylan

primaryContact   string  optional  

Customer primary contact name Example: Jane Smith

homeNumber   string  optional  

Customer home number Example: 11111111

mobileNumber   string  optional  

Customer mobile number Example: 0444444444

workNumber   string  optional  

Customer work number Example: 22222222

preferredContactNumber   string   

Preferred Contact Number Type(Home, Mobile, Work) Example: Home

contactEmail   email  optional  

Customer email address Example: bob@builder.com

abn   numeric  optional  

Customer ABN number Example: 12312312312

notes   string  optional  

Customer notes Example: This is customer notes

address   object  optional  
addressLine1   string  optional  

Customer address line 1 string Example: 1 Test Street

secondarySuburb   sting  optional  

Customer address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Customer address suburb Example: Brisbane

state   string  optional  

Customer address state(For Australia only) Example: QLD

country   string  optional  

Customer address country Example: Australia

postcode   string  optional  

Customer address postcode Example: 4000

postalSameAsAddress   boolean  optional  

set to true if the customer postal address is the same as customer address Example: false

postalAddress   object  optional  
addressLine1   string  optional  

Customer postal address line 1 Example: PO Box 123

secondarySuburb   sting  optional  

Customer postal address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   string  optional  

Customer postal address suburb Example: Brisbane

state   string  optional  

Customer postal address state(For Australia only) Example: QLD

country   string  optional  

Customer postal address country Example: Australia

postcode   string  optional  

Customer postal address postcode Example: 4000

siteSameAsCustomerAddress   boolean  optional  

set to true if the job address is the same as customer address Example: false

address   object  optional  
addressLine1   string  optional  

Job address line 1 Example: 1 Test Street

secondarySuburb   sting  optional  

Job address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   sting  optional  

Job address suburb Example: Brisbane

state   string  optional  

Job address state(For Australia only) Example: QLD

country   string  optional  

Job address country Example: Australia

postcode   string  optional  

Job address postcode Example: 4000

contactRelationships   object  optional  

Job Contact Relationships key/value pairs ("contact relationship type id": "contact id")

{ "d81090a7-c371-a660-b7ba-ab0cbd6f3994": "51ea9438-22fd-8304-77e5-60d95ee4c5c6", "6567ede3-ce2e-fa59-e2e1-aef8421a810b": "f88c6152-1572-6c03-3679-0f5a67608985" }

customFields   object  optional  

Job Custom Fields key/value pairs ("custom field name": "value")

{ "age-of-property": "7", "construction-type":"Brick Veneer" }

Update Job

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/jobs/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/jobs/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Body Parameters

attributes   object  optional  
clientReference   string   

Job client reference Example: AXB123

additionalReference   string  optional  

Job additional reference Example: AA00012

description   string  optional  

Job description Example: This is Job Description

divisionId   string  optional  

Job division id Example: 4653a4bc-6c57-4845-8ae9-9308a63baa25

jobType   string   

Job type Example: Quote

workflowId   string   

Job workflow id Example: 7d730fe6-dd16-49d0-b033-04dccfc7b9f0

statusId   string   

Job status id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07e

perilId   string  optional  

Job peril id Example: c99a2efe-088c-4c3a-a2b6-c26d1de0be39

catastropheCodeId   string  optional  

Job catastrophe code id Example: 4729e1d4-9dbc-49cb-9c5e-bcab8ff798ea

customerId   string  optional  

Job customer(contact) id - required if the customer section is not presented Example: 8566eb93-a1ea-4969-98e4-3502c8bcd422

clientId   string   

Job client(contact) id Example: accbc68e-dd7d-4234-a1f9-48a551b41702

assignedId   string  optional  

Job assigned(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

caseManagerId   string  optional  

Job Case Manager(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

supervisorId   string  optional  

Job Supervisor(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

estimatorId   string  optional  

Job Estimator(user) employee id Example: 5b308ddf-8fef-46a8-adc5-b3989c3ec07a

notes   string  optional  

Job notes Example: This is some job notes

excessAmount   numeric  optional  

Job excess amount Example: 500.00

primaryContactId   string  optional  

Job primary contact id Example: 10afcc68-2165-4706-a359-aa4654d48e91

businessId   string  optional  

Job Business(Company) id Example: dbe4141a-5bb3-8fb2-e8fb-2dc9cbdfa5b9

clientPortalId   string  optional  

Job Client Portal id Example: 0619eb17-73f4-11ef-8a1a-00fff7b445c2

incidentDate   date  optional  

Incident date Example: 2020-12-01

allocatedDate   datetime  optional  

Allocated date Example: 2020-12-01 16:40:00

brokerReference   string  optional  

Broker reference Example: ABC001

strataReference   string  optional  

Strata reference Example: ABC002

adjusterReference   string  optional  

Adjuster reference Example: ABC003

address   object  optional  
addressLine1   string  optional  

Job address line 1 Example: 1 Test Street

secondarySuburb   sting  optional  

Job address secondary suburb(City or Dependent Locality, For New Zealand and UK only) Example: Auckland Central

suburb   sting  optional  

Job address suburb or post-town Example: Brisbane

state   string  optional  

Job address state (For Australia only) Example: QLD

country   string  optional  

Job address country Example: Australia

postcode   string  optional  

Job address postcode Example: 4000

version   integer   

Version number Example: 1543444647

Update Job Status

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/status" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/status"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/jobs/{id}/relationships/status

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Body Parameters

data   object  optional  
id   string   

Job Status Id Example: a3315b6c-cb34-2378-ecb4-339252c9b36d

version   integer   

Version number Example: 1549808017

Update Job Custom Fields

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/jobCustomFields" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \
    --data "{
    \"attributes\": \"{\\\"4db7e75f-c408-2aee-40d2-760049ad0fc5\\\": \\\"17 years\\\",\\\"39bb21ef-c389-f7ac-6252-dc37fe1dbee0\\\": \\\"c282b12d-3082-11ea-a53f-080027f092e2\\\",\\\"3e51ea12-53a5-21ed-da05-bcede1a769da\\\": [\\\"c282be35-3082-11ea-a53f-080027f092e2\\\",\\\"c282bea0-3082-11ea-a53f-080027f092e2\\\",\\\"c282bf0d-3082-11ea-a53f-080027f092e2\\\"]}\"
}"

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/jobCustomFields"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

let body = {
    "attributes": "{\"4db7e75f-c408-2aee-40d2-760049ad0fc5\": \"17 years\",\"39bb21ef-c389-f7ac-6252-dc37fe1dbee0\": \"c282b12d-3082-11ea-a53f-080027f092e2\",\"3e51ea12-53a5-21ed-da05-bcede1a769da\": [\"c282be35-3082-11ea-a53f-080027f092e2\",\"c282bea0-3082-11ea-a53f-080027f092e2\",\"c282bf0d-3082-11ea-a53f-080027f092e2\"]}"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH {api_uri}/jobs/{id}/relationships/jobCustomFields

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Body Parameters

attributes   string   

Job Custom Fields key/value pairs Example: {"4db7e75f-c408-2aee-40d2-760049ad0fc5": "17 years","39bb21ef-c389-f7ac-6252-dc37fe1dbee0": "c282b12d-3082-11ea-a53f-080027f092e2","3e51ea12-53a5-21ed-da05-bcede1a769da": ["c282be35-3082-11ea-a53f-080027f092e2","c282bea0-3082-11ea-a53f-080027f092e2","c282bf0d-3082-11ea-a53f-080027f092e2"]}

Update Job Milestone Items

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/milestoneItems" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \
    --data "{
    \"attributes\": \"{\\\"4db7e75f-c408-2aee-40d2-760049ad0fc5\\\": \\\"2024-01-01\\\",\\\"39bb21ef-c389-f7ac-6252-dc37fe1dbee0\\\": \\\"2024-02-02\\\"}\"
}"

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/milestoneItems"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

let body = {
    "attributes": "{\"4db7e75f-c408-2aee-40d2-760049ad0fc5\": \"2024-01-01\",\"39bb21ef-c389-f7ac-6252-dc37fe1dbee0\": \"2024-02-02\"}"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH {api_uri}/jobs/{id}/relationships/milestoneItems

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Body Parameters

attributes   string   

Job Milestone Items key/value pairs Example: {"4db7e75f-c408-2aee-40d2-760049ad0fc5": "2024-01-01","39bb21ef-c389-f7ac-6252-dc37fe1dbee0": "2024-02-02"}

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/jobs/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

Sync Job to Easybuild

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/jobs/1/sync-to-easybuild" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/jobs/1/sync-to-easybuild"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/jobs/{id}/sync-to-easybuild

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job. Example: 1

List Upstream Jobs

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/upstream-jobs" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/upstream-jobs"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/upstream-jobs

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Upstream Job

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/upstream-jobs/necessitatibus" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/upstream-jobs/necessitatibus"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/upstream-jobs/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the upstream job. Example: necessitatibus

Job Contact Relationship

List ContactRelationships

requires authentication

jobId fitler is required. For example: {{apipath}}/contact-relationships?q='jobId'.eq('568167ca-665f-eee1-debc-0a2d97f3853f')

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-relationships" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationships"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/contact-relationships

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ContactRelationship

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/contact-relationships/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationships/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "contact-relationship",
        "id": "e6636799-5838-11ee-819a-00fff7b445c2",
        "attributes": {
            "jobId": "568167ca-665f-eee1-debc-0a2d97f3853f",
            "contactId": "500c899f-24d3-014c-a826-215a973af10f",
            "contactName": "RACQ Insurance",
            "contactRelationshipTypeId": "5276d87c-748f-4eeb-02fd-9c2356566b3f",
            "contactRelationshipTypeName": "Policy Owner",
            "version": 1480433183
        }
    }
}

Request   

GET {api_uri}/contact-relationships/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact relationship. Example: 4

Create ContactRelationship

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/contact-relationships" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationships"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/contact-relationships

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 568167ca-665f-eee1-debc-0a2d97f3853f

contactId   string   

Contact Id Example: 500c899f-24d3-014c-a826-215a973af10f

contactRelationshipTypeId   string   

Contact Relationship Type Id Example: b6b299cb-d68e-429c-aefc-481283d8c8fb

Update ContactRelationship

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/contact-relationships/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationships/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/contact-relationships/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact relationship. Example: 4

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 568167ca-665f-eee1-debc-0a2d97f3853f

contactId   string   

Contact Id Example: 500c899f-24d3-014c-a826-215a973af10f

contactRelationshipTypeId   string   

Contact Relationship Type Id Example: b6b299cb-d68e-429c-aefc-481283d8c8fb

version   integer   

Version number Example: 1695275593

Delete ContactRelationship

requires authentication

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/contact-relationships/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/contact-relationships/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/contact-relationships/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the contact relationship. Example: 4

JobCustomField

List JobCustomFields

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-custom-fields" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-custom-fields"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/job-custom-fields

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get JobCustomField

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-custom-fields/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-custom-fields/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/job-custom-fields/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job custom field. Example: 1

Job Expense Invoice

Job Expense Invoice Status
Approved
Cancelled
New
Paid
Sent
Approved Status
Pending
Approved
Not Approved
Disputed
Under Review

List Job Expense Invoices

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-expense-invoices" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/job-expense-invoices

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Job Expense Invoice

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "jobExpenseInvoice",
        "id": "04610e69-4a1b-f8ed-5857-57e62c009bbb",
        "attributes": {
            "jobId": "61863af9-ba2e-b98a-5dc1-f384fa5a7a05",
            "invoiceNumber": "LIVE001",
            "jobExpenseInvoiceStatus": "Sent",
            "jobExpenseInvoiceType": "Equipment Hire",
            "description": "sdf dfsdaf sd",
            "amount": "2345.0000",
            "tax": "0.1000",
            "taxTotal": "213.1818",
            "incurredDate": "2017-08-16",
            "dueDate": "2017-08-24",
            "accountNumber": "1-1110",
            "itemCode": "560",
            "assignedToId": "8d149e6c-68a3-55f1-fedc-a8c7083aad04",
            "attachmentId": "35486bec-a7fd-4447-8418-727b5a1ea001",
            "approvalStatus": "Disputed",
            "approvalNote": null,
            "approvedBy": "Tooly McToolface",
            "approvedAt": "2017-08-21 18:56:36",
            "createdAt": "2017-08-16 12:11:05",
            "createdBy": "Paul Smith",
            "updatedAt": "2017-08-21 18:56:36",
            "updatedBy": "Paul Smith",
            "isSynced": true,
            "version": 1503305796
        }
    }
}

Request   

GET {api_uri}/job-expense-invoices/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job expense invoice. Example: 1

Create Job Expense Invoice

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/job-expense-invoices

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
invoiceNumber   string   

Invoice number Example: INV001

description   string   

Invoice description Example: This is a test invoice

jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

assignedToId   string  optional  

Assigned Contact Id Example: defc6e82-4f7a-404e-8f03-3e545154170c

jobExpenseInvoiceStatusId   string  optional  

Job Expense Invoice Status Id - required if attributes.jobExpenseInvoiceStatus is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

jobExpenseInvoiceStatus   string  optional  

Job Expense Invoice Status Name - required if attributes.jobExpenseInvoiceStatusId is not presented Example: New

jobExpenseInvoiceTypeId   string  optional  

Job Expense Invoice Type Id - required if attributes.jobExpenseInvoiceType is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

jobExpenseInvoiceType   string  optional  

Job Expense Invoice Type Name - required if attributes.jobExpenseInvoiceTypeId is not presented Example: New

accountNumber   string  optional  

Account Number Example: 4-1000

itemCode   string  optional  

Item Code Example: FINAL

amount   decimal  optional  

Invoice Amount Example: 5000.50

noTax   boolean  optional  

set to 1 if no tax Example: false

incurredDate   date  optional  

Invoice incurred Date Example: 2019-01-01

dueDate   date  optional  

Invoice Due Date Example: 2019-01-31

attachment   file  optional  

Invoice File Example: C:\Users\gordo\AppData\Local\Temp\phpA37D.tmp

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

Update Job Expense Invoice

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/job-expense-invoices/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job expense invoice. Example: 1

Body Parameters

attributes   object  optional  
invoiceNumber   string   

Invoice number Example: INV001

description   string   

Invoice description Example: This is a test invoice

jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

assignedToId   string  optional  

Assigned Contact Id Example: defc6e82-4f7a-404e-8f03-3e545154170c

jobExpenseInvoiceStatusId   string  optional  

Job Expense Invoice Status Id - required if attributes.jobExpenseInvoiceStatus is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

jobExpenseInvoiceStatus   string  optional  

Job Expense Invoice Status Name - required if attributes.jobExpenseInvoiceStatusId is not presented Example: New

jobExpenseInvoiceTypeId   string  optional  

Job Expense Invoice Type Id - required if attributes.jobExpenseInvoiceType is not presented Example: cf8faab8-f541-b0f7-011f-58a9fcf77041

jobExpenseInvoiceType   string  optional  

Job Expense Invoice Type Name - required if attributes.jobExpenseInvoiceTypeId is not presented Example: New

accountNumber   string  optional  

Account Number Example: 4-1000

itemCode   string  optional  

Item Code Example: FINAL

amount   decimal  optional  

Invoice Amount Example: 5000.50

noTax   boolean  optional  

set to 1 if no tax Example: false

incurredDate   date  optional  

Invoice incurred Date Example: 2019-01-01

dueDate   date  optional  

Invoice Due Date Example: 2019-01-31

attachment   file  optional  

Invoice File Example: C:\Users\gordo\AppData\Local\Temp\phpA38D.tmp

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

version   integer   

Version number Example: 1543444647

Update Job Expense Invoice Status

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1/relationships/jobExpenseInvoiceStatus" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-expense-invoices/1/relationships/jobExpenseInvoiceStatus"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/job-expense-invoices/{id}/relationships/jobExpenseInvoiceStatus

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job expense invoice. Example: 1

Body Parameters

data   object  optional  
name   string   

Job Expense Invoice Status Example: Sent

version   integer   

Version number Example: 1503305796

Job History

List Job History

requires authentication

Examples:

  1. get job history items for a given job 'badfa407-4045-366b-95e5-5dc7e8e3a412'

{{apipath}}/histories?q='jobId'.eq('badfa407-4045-366b-95e5-5dc7e8e3a412')

  1. get history items of a certain history action '873aedab-41cc-11ef-bd3e-00fff7b445c2' for all jobs since '2023-10-20 14:00:00'

{{apipath}}/histories?q='historyActionId'.eq('873aedab-41cc-11ef-bd3e-00fff7b445c2'),'createdAt'.gt('2023-10-20 14:00:00')

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/histories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/histories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/histories

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Job History Action

List History Actions

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/history-actions" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/history-actions"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/history-actions

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get History Action

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/history-actions/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/history-actions/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/history-actions/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the history action. Example: 1

JobLink

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-links" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-links"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Get JobLink

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/job-links/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-links/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/job-links/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job link. Example: 4

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/job-links" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-links"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Update JobLink

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/job-links/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-links/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/job-links/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job link. Example: 4

Body Parameters

attributes   object  optional  
linkType   string   

Job Link Type Example: dependent

parentJobId   string  optional  

Parent Job id Example: 40d4d8fd-0cbc-4ed3-9a03-ffe64bd39450

childJobId   string  optional  

Child Job id Example: 547a3611-48c6-4ef9-ac2a-2851cc94a170

version   integer   

Version number Example: 1543444647

Delete Job Link

requires authentication

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/job-links/4" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/job-links/4"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/job-links/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the job link. Example: 4

Job Status

List Job Statuses

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/statuses" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/statuses"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/statuses

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Job Status

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/statuses/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/statuses/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "status",
        "id": "a3315b6c-cb34-2378-ecb4-339252c9b36d",
        "attributes": {
            "name": "Appointment Required",
            "description": "appointment required",
            "statusType": "Open",
            "version": 0
        }
    }
}

Request   

GET {api_uri}/statuses/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the status. Example: 1

Licence

Licence Status
Active
Pending
Incomplete
Obsolete
Licence Types
Licence
Insurance
Contract
Health & Safety
CM3
WWC

List Licences

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/licences" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/licences"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/licences

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Licence

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/licences/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/licences/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/licences/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the licence. Example: 1

Create Licence

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/licences" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/licences"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/licences

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
state   string  optional  

Linked state name Example: QLD

number   string  optional  

Licence number Example: A00001

expiryDate   string  optional  

Licence expiry date Example: 2023-09-22

label   string  optional  

Licence name Example: QBCC Licence

attachmentId   string  optional  

Licence attachment id Example: 795b1dc8-951a-46d5-90ca-bc5fff330caf

licenceType   string   

Licence name Example: Insurance

licenceStatus   string   

Licence name Example: Active

Update Licence

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/licences/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/licences/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/licences/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the licence. Example: 1

Body Parameters

attributes   object  optional  
state   string  optional  

Linked state name Example: QLD

number   string  optional  

Licence number Example: A00001

expiryDate   string  optional  

Licence expiry date Example: 2023-09-22

label   string  optional  

Licence name Example: QBCC Licence

attachmentId   string  optional  

Licence attachment id Example: 795b1dc8-951a-46d5-90ca-bc5fff330caf

licenceType   string   

Licence name Example: Insurance

licenceStatus   string   

Licence name Example: Active

Milestone

List Milestones

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/milestones" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/milestones"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/milestones

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Milestone

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/milestones/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/milestones/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "milestones",
        "id": "64518b78-9b67-11eb-96f7-34c93d5aba49",
        "attributes": {
            "label": "Job Received from Client",
            "description": "Job Received from Client",
            "fieldType": "datetime",
            "allowNotes": 1,
            "visible": 1,
            "version": 1545144245
        }
    }
}

Request   

GET {api_uri}/milestones/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the milestone. Example: 1

MilestoneItem

Milestone Types
boolean
datetime
date
time

List MilestoneItems

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/milestone-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/milestone-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/milestone-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get MilestoneItem

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/milestone-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/milestone-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/milestone-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the milestone item. Example: 1

Update MilestoneItem

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/milestone-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/milestone-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/milestone-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the milestone item. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Linked state name Example: 7343ba41-8de4-463e-beaf-3499f644e812

milestoneId   string   

Linked state name Example: c4e16985-f3d1-45f2-9a62-a3db50bd0519

value   string  optional  

Linked state name Example: 2021-02-23 07:30:45

notes   string  optional  

Linked state name Example: Please review.

Notification

Notification Channel
note
email
sms
Notification Type
Internal
Customer
Client
Internal Email
Customer Contact
Client Contact
Contractor
Contractor Contact

List Notifications

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/notifications" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/notifications"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/notifications

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Notification

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/notifications/0018dbaf-4ee9-42b3-a085-d840ed8f0fa6" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/notifications/0018dbaf-4ee9-42b3-a085-d840ed8f0fa6"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "notification",
        "id": "76548781-b999-42ec-a27b-b80109958a8c",
        "attributes": {
            "jobId": "17cf4834-1c45-0cd1-9dc0-91d9098f1812",
            "notificationChannel": "note",
            "notificationType": "Client",
            "notificationTemplateId": "c31ab7e5-3082-11ea-a53f-080027f092e2",
            "data": {
                "note": "test test"
            },
            "createdAt": "2020-01-06 23:57:04",
            "createdBy": "Titus Raynor"
        }
    }
}

Request   

GET {api_uri}/notifications/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the notification. Example: 0018dbaf-4ee9-42b3-a085-d840ed8f0fa6

Create Job Notification

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/notifications" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/notifications"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/notifications

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job id name Example: 17cf4834-1c45-0cd1-9dc0-91d9098f1812

notificationChannel   string  optional  

Notification channel Example: note

notificationType   string  optional  

Notification type Example: Client

notificationTemplateId   string  optional  

Notification template id Example: c31ab7e5-3082-11ea-a53f-080027f092e2

note   string  optional  

note content - required if attributes.notificationChannel is note Example: this is a test note

Peril

List Perils

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/perils" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/perils"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/perils

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Peril

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/perils/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/perils/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/perils/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the peril. Example: 1

Create Peril

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/perils" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/perils"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/perils

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
label   string   

Peril name Example: Storm

Update Peril

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/perils/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/perils/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/perils/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the peril. Example: 1

Body Parameters

attributes   object  optional  
label   string   

Peril name Example: Storm

version   integer   

Version number Example: 1543444647

PowerBI

We have a PowerBI connector. Please contact us to find out more.

List Schema

requires authentication

Available Power BI Types are string = Text.Type, integer = Int64.Type, number = type number, date = Date.Type, datetime = DateTime.Type

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/powerbi/schema" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/powerbi/schema"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/powerbi/schema

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Reminder

Reminder Status
New
Completed
Cancelled
Reminder Priority
Critical
Normal
Low

List Reminders

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reminders" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminders"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/reminders

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Reminder

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reminders/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminders/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/reminders/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the reminder. Example: 1

Create Reminder

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/reminders" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminders"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/reminders

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

userId   string   

User Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

reminderPriority   string   

Reminder priority Example: Normal

reminderStatus   string   

Reminder status Example: New

reminderTemplateId   string  optional  

Reminder template id Example: f647eb74-3b48-11ea-ab87-080027f092e2

dueDate   string   

Reminder due date Example: 2016-12-18 18:43:01

title   string   

Reminder title Example: Call back client

description   string  optional  

Reminder description Example: This is the reminder description

Update Reminder

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/reminders/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminders/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/reminders/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the reminder. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 83bcb99f-3b1e-eea5-7c26-efd099b71479

userId   string   

User Id Example: bb2b0f0d-4e35-526e-050a-82484ca56f94

reminderPriority   string   

Reminder priority Example: Normal

reminderStatus   string   

Reminder status Example: New

reminderTemplateId   string  optional  

Reminder template id Example: f647eb74-3b48-11ea-ab87-080027f092e2

dueDate   string   

Reminder due date Example: 2016-12-18 18:43:01

title   string   

Reminder title Example: Call back client

description   string  optional  

Reminder description Example: This is the reminder description

version   integer   

Version number Example: 1543444647

ReminderTemplate

List ReminderTemplates

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reminder-templates" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminder-templates"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/reminder-templates

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ReminderTemplate

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reminder-templates/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reminder-templates/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "reminderTemplate",
        "id": "f647eb74-3b48-11ea-ab87-080027f092e2",
        "attributes": {
            "reminderPriority": "Normal",
            "duePeriod": 2880,
            "title": "Call Back Client",
            "description": "Return call to client to respond to query",
            "version": 1483066542
        }
    }
}

Request   

GET {api_uri}/reminder-templates/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the reminder template. Example: 1

ReserveCategory

List ReserveCategories

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reserve-categories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reserve-categories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/reserve-categories

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ReserveCategory

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reserve-categories/13" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reserve-categories/13"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "reserveCategory",
        "id": "e5c370b3-3b48-11ea-ab87-080027f092e2",
        "attributes": {
             "label": "Reserve Category Label",
             "reserveCategoryTypeLabel": "Type",
             "tagLabels": [
                 "My Tag"
             ],
             "active": 1,
             "updatedAt": "2024-01-01 14:00:00",
             "updatedBy": "User Name"
             "version": 1533345093
        }
    }
}

Request   

GET {api_uri}/reserve-categories/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the reserve category. Example: 13

ReserveItem

List ReserveItems

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reserve-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reserve-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/reserve-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get ReserveItem

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/reserve-items/20" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/reserve-items/20"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "reserveItem",
        "id": "e5c370b3-3b48-11ea-ab87-080027f092e2",
        "attributes": {
            "jobId": "f1365f81-a343-4d02-95bf-b35c49d7260d",
            "reserveCategoryId": "94b6e854-e8b0-45e8-a970-9b6d8763ed6b",
            "reserveItemStatusLabel": "Active",
            "sumInsuredTotal": "1000.00",
            "initialReserveTotal": "2000.00",
            "currentReserveTotal": "3000.00",
            "currentReserveNetTotal": "3000.00",
            "authorisedTotal": "3000.00",
            "paidPaymentsTotal": "6000.00",
            "outstandingReserveTotal": "3000.00",
            "updatedAt": "2024-01-01 14:00:00",
            "updatedBy": "User name",
            "version": 1533345093
        }
    }
}

Request   

GET {api_uri}/reserve-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the reserve item. Example: 20

Schedule

Job Schedule

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/schedules/job/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedules/job/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/schedules/job/{jobId}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

jobId   integer   

Example: 1

Get Schedule

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/schedules/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedules/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "schedule",
        "id": "d179bb8f-86bc-11ef-8841-0a002700000b",
        "attributes": {
            "jobId": "acbc97f2-1a5e-4975-b862-9034c42270d2",
            "label": "Works Schedule",
            "description": null,
            "scheduleType": "Works",
            "attachmentId": null,
            "encodedLinkToken": null,
            "scheduleItems": [
                {
                    "id": "d188aad7-86bc-11ef-8841-0a002700000b",
                    "label": "DCT83DCT0001087",
                    "description": "In Progress",
                    "objectType": "WorkOrder",
                    "objectId": "2d49a5aa-4cad-488b-b5ad-4f8b45661dca",
                    "start": "2022-11-22",
                    "end": "2022-11-24",
                    "startTime": "08:00:00",
                    "endTime": "13:30:39",
                    "assignedId": "184159dd-ee1d-4d68-826f-65fbb4f34796",
                    "visible": 1,
                    "linksFrom": [
                        "d188abe8-86bc-11ef-8841-0a002700000b"
                    ],
                    "linksTo": [],
                    "version": 1728615418
                },
                {
                    "id": "d188abe8-86bc-11ef-8841-0a002700000b",
                    "label": "Meeting with supervisor",
                    "description": "undefined",
                    "objectType": null,
                    "objectId": null,
                    "start": "2022-11-18",
                    "end": "2022-11-19",
                    "startTime": null,
                    "endTime": null,
                    "assignedId": null,
                    "visible": 1,
                    "linksFrom": [],
                    "linksTo": [
                        "d188aad7-86bc-11ef-8841-0a002700000b"
                    ],
                    "version": 1728615418
                }
            ],
            "createdAt": "2022-07-01 09:16:48",
            "createdBy": "Paul Grant",
            "updatedAt": "2022-11-18 12:46:05",
            "updatedBy": "Paul Grant",
            "version": 1668775565
        }
    }
}

Request   

GET {api_uri}/schedules/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the schedule. Example: 1

Create Schedule

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/schedules" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedules"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/schedules

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

scheduleType   string   

Schedule Type (only Works is supported) Example: Works

label   string   

Schedule Label Example: Works Schedule

description   string  optional  

Description Example: Works Schedule

attachmentId   string  optional  

Attachment Id Example: 24d4511b-5768-4a42-89f5-24ed9b44f613

Update Schedule

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/schedules/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedules/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/schedules/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the schedule. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

scheduleType   string   

Schedule Type (only Works is supported) Example: Works

label   string   

Schedule Label Example: Works Schedule

description   string  optional  

Description Example: Works Schedule

attachmentId   string  optional  

Attachment Id Example: 24d4511b-5768-4a42-89f5-24ed9b44f613

version   integer   

Version number Example: 1543444647

Job Schedule Items

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/schedule-items/job/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-items/job/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/schedule-items/job/{jobId}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

jobId   integer   

Example: 1

Get Schedule Item

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/schedule-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
         "type": "scheduleItem",
         "id": "d188ace7-86bc-11ef-8841-0a002700000b",
         "attributes": {
             "jobId": "e2ae1c76-a30c-4e81-9707-00dfa7aa353c",
             "scheduleId": "d179bc93-86bc-11ef-8841-0a002700000b",
             "label": "DCT85DCT0001087",
             "description": "In Progress",
             "objectType": "WorkOrder",
             "objectId": "2d49a5aa-4cad-488b-b5ad-4f8b45661dca",
             "start": "2023-05-18",
             "end": "2023-05-20",
             "startTime": null,
             "endTime": null,
             "assignedId": "184159dd-ee1d-4d68-826f-65fbb4f34796",
             "visible": 1,
             "linksFrom": [],
             "linksTo": [
                 "d188ade4-86bc-11ef-8841-0a002700000b",
                 "d188aee0-86bc-11ef-8841-0a002700000b"
             ],
             "version": 1684475746
    }
}

Request   

GET {api_uri}/schedule-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the schedule item. Example: 1

Create Schedule Item

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/schedule-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/schedule-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

scheduleId   string   

Schedule Id Example: d179bb8f-86bc-11ef-8841-0a002700000b

label   string   

Schedule Item Label Example: Meeting with supervisor

description   string  optional  

Description Example: hazaard morning

assignedId   string  optional  

Assigned Contact Id Example: 37ae90a7-d91f-2c45-af1d-cd19155e184f

start   date  optional  

Start Date Example: 2024-09-09

startTime   time  optional  

Start Time Example: 15:56:18

end   date  optional  

Start Date Example: 2024-09-09

endTime   time  optional  

End Time Example: 07:50:00

visible   boolean   

Visible Example: true

Update Schedule Item

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/schedule-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/schedule-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the schedule item. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

scheduleId   string   

Schedule Id Example: d179bb8f-86bc-11ef-8841-0a002700000b

label   string   

Schedule Item Label Example: Meeting with supervisor

description   string  optional  

Description Example: hazaard morning

assignedId   string  optional  

Assigned Contact Id Example: 37ae90a7-d91f-2c45-af1d-cd19155e184f

start   date  optional  

Start Date Example: 2024-09-09

startTime   time  optional  

Start Time Example: 15:56:18

end   date  optional  

Start Date Example: 2024-09-09

endTime   time  optional  

End Time Example: 07:50:00

visible   boolean   

Visible Example: true

version   integer   

Version number Example: 1543444647

Delete Schedule Item

requires authentication

Delete schedule item and all schedule item links relate to this item.

Example request:
curl --request DELETE \
    "https://www.primeeco.tech/api.prime/v2/schedule-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE {api_uri}/schedule-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the schedule item. Example: 1

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/schedule-item-links" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-item-links"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/schedule-item-links/deleteLink" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/schedule-item-links/deleteLink"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

SiteForm

status
Not Started
In Progress
Awaiting Approval
Completed
Cancelled

List Site Forms

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/site-forms" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/site-forms"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/site-forms

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Site Form

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/site-forms/soluta" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/site-forms/soluta"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "siteForm",
        "id": "9aa70d4d-5ba4-11ef-a0eb-00fff7b445c2",
        "attributes": {
            "number": "AJ64--CF00178",
            "label": "AJ64--CF00178",
            "jobId": "5db33a72-d7c3-de49-77ac-c96f1564c81c",
            "objectId": "5db33a72-d7c3-de49-77ac-c96f1564c81c",
            "objectType": "Job",
            "template": "Inspection Form",
            "status": "In Progress",
            "attachmentId": "4c5d5cec-527a-4cd7-9240-d0a1e6d0f198",
            "notes": "test",
            "assignedContact": null,
            "assignedUser": "Andrew Smith",
            "approvedBy": "Mike Doe",
            "approvedAt": "2024-08-17T02:41:44.000000Z",
            "items": [
                {
                    "id": "61737eed-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "92564a62-cc7d-4f99-8cd8-66482f45329c",
                    "customFieldType": "attachments",
                    "customFieldLabel": "Property Photos",
                    "value": [
                        "https://test.s3.ap-southeast-2.amazonaws.com/company/1723861677848_image_20240713190514.jpg?uuid=66bf1bc2-36e1-4fee-b931-bde53eeee027&type=original&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJWI2PN62XOXJO5DQ%2F20240817%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240817T023539Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=1842ae4c83e8045854c8c36e2e51c131885fd54d7bf4276d472754dabf58c6a4"
                    ]
                },
                {
                    "id": "61738006-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "45ff79b4-e5fd-4a6e-a772-e44a9ae79150",
                    "customFieldType": "signature",
                    "customFieldLabel": "Customer Signature",
                    "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAXoAAABkCAYAAACIC/vPAAAAAXNSR0IArs4c6QAADxZJREFUeF7tnfevBUUZhl+wdxE7dgyKYhdsqGAvsSWo0R/UaFCIJgaBRP8B/UEsCUGMBI0xgVhixW4EsUTEDkoT7FEUpalY0X3IfDiue+/ds3dmz+6e"
                },
                {
                    "id": "6173826f-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "1af67280-e3ab-2b8a-aff9-eb55bfd7c048",
                    "customFieldType": "select",
                    "customFieldLabel": "Construction Type",
                    "value": "Weatherboard"
                },
                {
                    "id": "61738492-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "005d3e30-7439-036c-7318-76d87d6c06f2",
                    "customFieldType": "text",
                    "customFieldLabel": "Age of Property",
                    "value": "12"
                },
                {
                    "id": "617387b6-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "85ff0a75-fbe7-a0e8-731e-d9ca7ca9bbe1",
                    "customFieldType": "multiselect",
                    "customFieldLabel": "Types of Hazards",
                    "value": [
                        "Asbestos",
                        "Lead Paint"
                    ]
                },
                {
                    "id": "617388be-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "e06a5dcb-a901-f686-f20f-14088480ab54",
                    "customFieldType": "select",
                    "customFieldLabel": "Previous Related Claims",
                    "value": "Yes"
                },
                {
                    "id": "617389ce-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "d548f8e6-041b-df25-0461-e6c5ca7f1478",
                    "customFieldType": "multitext",
                    "customFieldLabel": "Details of Previous Claims",
                    "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed quis turpis at est pulvinar malesuada. Nullam lorem massa, dictum quis ipsum vel, rhoncus convallis nisl. Praesent sit amet nunc justo. Sed lacinia mattis diam a rutrum. Sed tincidunt, tellus ut aliquet cursus, eros lorem convallis enim, eu tempus mauris ligula at risus."
                },
                {
                    "id": "61738ad6-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "162a195f-0c40-0f41-9f0a-fcfe748e4e8c",
                    "customFieldType": "message",
                    "customFieldLabel": "Instructions if Site Access Restricted",
                    "value": "STOP:  Check with WHS Adviser to determine whether traffic control is required prior to site attendance by trades/suppliers"
                },
                {
                    "id": "61738ce1-5ba0-11ef-a0eb-00fff7b445c2",
                    "customFieldId": "573e94b1-00b6-4053-888d-de5770e48eb1",
                    "customFieldType": "date",
                    "customFieldLabel": "My Date",
                    "value": "2024-08-24",
                    "timezone": "Australia/Brisbane"
                }
            ],
            "version": 1723861683
        }
    }
}

Request   

GET {api_uri}/site-forms/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the site form. Example: soluta

Status History

List Status History

requires authentication

objectType Description
Job Job
Appointment Appointment
Estimate Unlocked Estimate
EstimateSnapshot Locked Estimate
Allocation Allocation
WorkOrder Work Order
AccountsPayableInvoice Accounts Payable Invoice
AccountsReceivableInvoice Accounts Receivable Invoice
JobExpenseInvoice Job Expense Invoice

Examples:

  1. get all types of status history for a given job

{{apipath}}/status-histories?q='jobId'.eq('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')

  1. get all Appointment type status history for all jobs since '2023-10-20 14:00:00'

{{apipath}}/status-histories?q='objectType'.eq('Appointment'),'createdAt'.gt('2023-10-20 14:00:00')

  1. get all Estimate type status history for a given estimate

{{apipath}}/status-histories?q='objectType'.eq('Estimate'),'objectId'.eq('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/status-histories" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/status-histories"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/status-histories

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

SyncExternal

Create GenericPayload

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/sync-external/generic-payload" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/sync-external/generic-payload"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/sync-external/generic-payload

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
externalReference   string   

Supply the same reference you gave when the model you're replying to was created in your system. Example: 123456

externalSystem   string   

The name of your external system Example: ExternalSystem

externalMasterfile   string   

The name of the model/masterfile you're sending from Example: Job

genericPayload   string  optional  

The payload you're sending, this should have been defined with Prime during the setup of your external system. Example: eaque

Timesheet

Approved Status
Pending
Approved
Not Approved
Disputed
Under Review

List Timesheets

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheets" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheets"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/timesheets

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Timesheet

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheets/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheets/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "timesheet",
        "id": "4d668b49-ea4c-4c7d-a629-f0772fc866c8",
        "attributes": {
            "jobId": "b40652f8-72f0-4b1e-93b2-d0730a8fa592",
            "timesheetRoleId": "aaac102f-69f0-11ec-81d3-34c93d5aba49",
            "timesheetActivityId": "aab2eef6-69f0-11ec-81d3-34c93d5aba49",
            "userId": "54a8d8ea-7d57-632e-58b3-6af88b7cd7f7",
            "afterhours": true,
            "notes": "notes1",
            "rate": "11.00",
            "total": -13.75,
            "unpaidBreak": 120,
            "paidBreak": 45,
            "timezone": "Australia/Brisbane",
            "jobExpenseInvoiceId": "9b962763-2ebe-4ef2-85f8-5d238e8a7bb6",
            "accountsPayableInvoiceId": null,
            "commencedAt": "2022-01-03 07:50:00",
            "completedAt": "2022-01-03 08:35:00",
            "approvalStatusId": "Approved",
            "approvalNote": "approval note",
            "approvedById": "453948d0-5dcb-3b1a-628e-60635f7b03e5",
            "approvedAt": "2022-01-04 13:02:36",
            "createdAt": "2022-01-02 21:47:57",
            "createdBy": "Test User",
            "updatedAt": "2022-01-02 21:47:57",
            "updatedBy": "Test User",
            "version": 1641124077
        }
    }
}

Request   

GET {api_uri}/timesheets/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the timesheet. Example: 1

Create Timesheet

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/timesheets" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheets"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/timesheets

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

timesheetActivityId   string   

Timesheet Activity Id Example: aab2eef6-69f0-11ec-81d3-34c93d5aba49

timesheetRoleId   string   

Timesheet Role Id Example: aaac102f-69f0-11ec-81d3-34c93d5aba49

isLinkedToContact   boolean   

Indicate Timesheet is linked to contact or not Example: false

userId   string  optional  

User Id - required if isLinkedToContact is false Example: 54a8d8ea-7d57-632e-58b3-6af88b7cd7f7

contactId   string  optional  

Contact Id - required if isLinkedToContact is true Example: 022ab15c-d5e3-7334-3099-8dac1a6ccf2f

assignedContactId   string  optional  

Contact Employee Id Example: 749dc1ba-a07a-c146-58a8-3105ce7244b1

firstName   string   

Assigned person first name Example: Adam

lastName   string   

Assigned person last name Example: Smith

timezone   string  optional  

Indicate commencedAt and completedAt value timezone - UTC by default Example: Australia/Brisbane

commencedAt   datetime   

Timesheet Commenced At Example: 2022-01-03 07:50:00

completedAt   datetime   

Timesheet Completed At Example: 2022-01-03 09:50:00

afterhours   boolean   

Indicate Timesheet is after hours or not Example: true

notes   string  optional  

Notes Example: Test notes

rate   string   

Cost Rate Example: 10.00

total   string   

Cost Total Example: 20.00

sellRate   string   

Sell Rate Example: 15.00

sellTotal   string   

Sell Total Example: 30.00

unpaidBreak   string   

Unpaid Break Time in minutes Example: 30

paidBreak   string   

Paid Break Time in minutes Example: 20

createExpense   boolean  optional  

Create Expense Invoice based on this Timesheet Example: true

createApInvoice   boolean  optional  

Link Work Order and Create Accounts Payable Invoice based on this Timesheet Example: false

workOrderId   string  optional  

Work Order Id - required if createApInvoice is true Example: 6d9f7f1d-1d73-432d-9e0f-e10561327e4e

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

Update Timesheet

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/timesheets/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheets/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/timesheets/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the timesheet. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: b40652f8-72f0-4b1e-93b2-d0730a8fa592

timesheetActivityId   string   

Timesheet Activity Id Example: aab2eef6-69f0-11ec-81d3-34c93d5aba49

timesheetRoleId   string   

Timesheet Role Id Example: aaac102f-69f0-11ec-81d3-34c93d5aba49

isLinkedToContact   boolean   

Indicate Timesheet is linked to contact or not Example: false

userId   string  optional  

User Id - required if isLinkedToContact is false Example: 54a8d8ea-7d57-632e-58b3-6af88b7cd7f7

contactId   string  optional  

Contact Id - required if isLinkedToContact is true Example: 022ab15c-d5e3-7334-3099-8dac1a6ccf2f

assignedContactId   string  optional  

Contact Employee Id Example: 749dc1ba-a07a-c146-58a8-3105ce7244b1

firstName   string   

Assigned person first name Example: Adam

lastName   string   

Assigned person last name Example: Smith

timezone   string  optional  

Indicate commencedAt and completedAt value timezone - UTC by default Example: Australia/Brisbane

commencedAt   datetime   

Timesheet Commenced At Example: 2022-01-03 07:50:00

completedAt   datetime   

Timesheet Completed At Example: 2022-01-03 09:50:00

afterhours   boolean   

Indicate Timesheet is after hours or not Example: true

notes   string  optional  

Notes Example: Test notes

rate   string   

Cost Rate Example: 10.00

total   string   

Cost Total Example: 20.00

sellRate   string   

Sell Rate Example: 15.00

sellTotal   string   

Sell Total Example: 30.00

unpaidBreak   string   

Unpaid Break Time in minutes Example: 30

paidBreak   string   

Paid Break Time in minutes Example: 20

createExpense   boolean  optional  

Create Expense Invoice based on this Timesheet Example: true

createApInvoice   boolean  optional  

Link Work Order and Create Accounts Payable Invoice based on this Timesheet Example: false

workOrderId   string  optional  

Work Order Id - required if createApInvoice is true Example: 6d9f7f1d-1d73-432d-9e0f-e10561327e4e

approvalStatus   string  optional  

Approval Status Example: Pending

approvalNote   string  optional  

Approval Note Example: This is a test approval note

version   integer   

Version number Example: 1543444647

TimesheetActivity

List TimesheetActivities

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheet-activities" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheet-activities"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/timesheet-activities

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get TimesheetActivity

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheet-activities/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheet-activities/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "timesheetActivity",
        "id": "aab2eef6-69f0-11ec-81d3-34c93d5aba49",
        "attributes": {
            "label": "Site Inspection",
            "description": "Site Inspection",
            "visible": 1,
            "version": 1495290988
        }
    }
}

Request   

GET {api_uri}/timesheet-activities/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the timesheet activity. Example: 1

TimesheetRole

List TimesheetRoles

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheet-roles" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheet-roles"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/timesheet-roles

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get TimesheetRole

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/timesheet-roles/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/timesheet-roles/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "timesheetRole",
        "id": "aaabfccd-69f0-11ec-81d3-34c93d5aba49",
        "attributes": {
            "label": "General Trade",
            "description": "General Trade",
            "rate": "60.00",
            "afterhoursRate": "80.00",
            "sellRate": "60.00",
            "afterhoursSellRate": "80.00",
            "visible": 1,
            "version": 1568366642
        }
    }

Request   

GET {api_uri}/timesheet-roles/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the timesheet role. Example: 1

TodoItem

List TodoItems

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/todo-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/todo-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/todo-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get TodoItem

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/todo-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/todo-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "todoItem",
        "id": "f48b2d0c-7a05-11ea-8468-08002732ed09",
        "attributes": {
            "jobId": "be2db686-a487-4b96-9e17-c69d6cec22ae",
            "todoType": "Reminder",
            "userId": "994f753a-0db5-7521-0dfd-a969d27deed2",
            "due": "2019-02-03 15:22:48",
            "completed": null,
            "label": "Arrange Site Inspection",
            "description": "Book appointment to attend site to complete assessment/quote",
            "createdAt": "2019-02-01 01:22:58",
            "createdBy": "Nike Smith",
            "updatedAt": "2019-02-01 01:22:58",
            "updatedBy": "Nike Smith",
            "version": 1548948178
        }
    }

Request   

GET {api_uri}/todo-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the todo item. Example: 1

Trade

List Trades

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/trades" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/trades"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/trades

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Trade

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/trades/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/trades/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "trade",
        "id": "59d47247-6ee4-11ec-81d3-34c93d5aba49",
        "attributes": {
            "label": "Fencing",
            "description": "Fencing"
        }
    }
}

Request   

GET {api_uri}/trades/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the trade. Example: 1

Unit

List Units

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/units" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/units"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/units

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Unit

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/units/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/units/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "unit",
        "id": "59dd7d8f-6ee4-11ec-81d3-34c93d5aba49",
        "attributes": {
            "label": "m2",
            "description": "Square Metre"
        }
    }
}

Request   

GET {api_uri}/units/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the unit. Example: 1

User

List Users

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/users" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/users"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/users

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get User

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/users/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/users/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "user",
        "id": "fe202e7d-52aa-916c-77b8-dc878e84886b",
        "attributes": {
            "firstName": "Adella",
            "lastName": "Graham",
            "fullName": "Adella Graham",
            "status": "active",
            "email": "user3@example.com",
            "timezone": "Australia/Brisbane",
            "contactId": "6cca58ce-050e-d673-4dc1-7b571f3df51b",
            "version": 1479512238
        }
    }
}

Request   

GET {api_uri}/users/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

WHS Item

WHS Item Status (Prime Default)
New
Under Investigation
Mitigation Completed
Repairs Completed
Cancelled

List WHS Items Status

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-item-statuses" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/whs-item-statuses

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get WHS Item Status

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-item-statuses/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "whs-item-status",
        "id": "32863739-85ed-11ef-9479-0a002700000b",
        "attributes": {
            "name": "new_whs_status",
            "label": "New WHS Status",
            "description": null,
            "active": 1,
            "companyId": "32f92994-d077-11ee-b25d-0a002700000b",
            "updatedAt": "2021-09-20 13:22:02",
            "updatedBy": "Paul Grant",
            "version": 1632144122
        }
    }
}

Request   

GET {api_uri}/whs-item-statuses/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item status. Example: 1

Create WHS Item Status

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/whs-item-statuses

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
name   string   

WHS Item Status Name Example: new_whs_status

label   string   

WHS Item Status Label Example: New WHS Status

description   string  optional  

description Example: New WHS Status description

active   boolean   

Active Example: true

Update WHS Item Status

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-statuses/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/whs-item-statuses/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item status. Example: 1

Body Parameters

attributes   object  optional  
name   string   

WHS Item Status Name Example: new_whs_status

label   string   

WHS Item Status Label Example: New WHS Status

description   string  optional  

description Example: New WHS Status description

active   boolean   

Active Example: true

version   integer   

Version number Example: 1728364311

List WHS Item Types

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-item-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/whs-item-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get WHS Item Type

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-item-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
         "type": "whs-item-type",
         "id": "32753bc6-85ed-11ef-9479-0a002700000b",
         "attributes": {
             "name": "accident",
             "label": "Accident",
             "description": null,
             "active": 1,
             "companyId": "32f92994-d077-11ee-b25d-0a002700000b", (If companyId is null, that is Prime default WHS item type)
             "updatedAt": "2024-10-09 04:13:20",
             "updatedBy": "Paul Grant",
             "version": 1728447200
         }
    }
}

Request   

GET {api_uri}/whs-item-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item type. Example: 1

Create WHS Item Type

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/whs-item-types" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-types"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/whs-item-types

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
name   string   

WHS Item Type Name Example: accident

label   string   

WHS Item Type Label Example: Accident

description   string  optional  

description Example: Accident description

active   boolean   

Active Example: true

Update WHS Item Type

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/whs-item-types/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-item-types/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/whs-item-types/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item type. Example: 1

Body Parameters

attributes   object  optional  
name   string   

WHS Item Type Name Example: accident

label   string   

WHS Item Type Label Example: Accident

description   string  optional  

description Example: Accident description

active   boolean   

Active Example: true

version   integer   

Version number Example: 1728364311

List WHS Items

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/whs-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get WHS Item

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/whs-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "whs-item",
        "id": "94fed30b-4ac9-4877-896a-fbc04e4b9d01",
        "attributes": {
            "jobId": "2ac76583-99c9-453a-aee6-7c50b12c8b0f",
            "whsItemTypeId": "3274f6af-85ed-11ef-9479-0a002700000b",
            "whsItemTypeLabel": "Hazard",
            "whsItemStatusId": "32862b2f-85ed-11ef-9479-0a002700000b",
            "whsItemStatusLabel": "New",
            "label": "DCT120-WHS01038",
            "description": "incident",
            "loggedById": "6ae240d6-1a0f-44ba-a6c3-8b070be48555",
            "loggedByName": "Paul Grant",
            "linkedContactId": null,
            "linkedContactName": null,
            "nearMiss": 0,
            "incidentDate": "2024-10-09 01:13:11",
            "mitigatedDate": "2024-10-08 15:11:45",
            "resolvedDate": "",
            "costTotal": "0.00",
            "attachmentIds": [
                "24c3ce2f-7910-4eef-a64b-01fc1d67a54d"
            ],
            "allocationIds": [
                "7e7bac7b-0366-4cb6-968c-964c1c72fdf3"
            ],
            "filterTags": [],
            "createdAt": "2024-10-08 04:10:19",
            "createdBy": "Paul Grant",
            "updatedAt": "2024-10-08 05:11:51",
            "updatedBy": "Paul Grant",
            "version": 1728364311
        }
    }
}

Request   

GET {api_uri}/whs-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item. Example: 1

Create WHS Item

requires authentication

Example request:
curl --request POST \
    "https://www.primeeco.tech/api.prime/v2/whs-items" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-items"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST {api_uri}/whs-items

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

whsItemTypeId   string   

WHS Item Type Id Example: 3274f6af-85ed-11ef-9479-0a002700000b

whsItemStatusId   string   

WHS Item Status Id Example: 32863739-85ed-11ef-9479-0a002700000b

description   string  optional  

description Example: hazaard morning

loggedById   string   

Logged By User Id Example: b493387d-2bf4-1687-799a-590e4eb27463

linkedContactId   string  optional  

Linked Contact Id Example: 1adfc430-f1e7-42ea-8071-b92d77369037

nearMiss   boolean   

Near Miss Example: true

incidentDate   datetime   

Incident Date Example: 2022-01-03 07:50:00

mitigatedDate   datetime  optional  

Mitigated Date Example: 2022-01-03 07:50:00

resolvedDate   datetime  optional  

resolved Date Example: 2022-01-03 07:50:00

costTotal   decimal  optional  

WHS Item Cost Total Example: 280.00

Update WHS Item

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/whs-items/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-items/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/whs-items/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item. Example: 1

Body Parameters

attributes   object  optional  
jobId   string   

Job Id Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

whsItemTypeId   string   

WHS Item Type Id Example: 3274f6af-85ed-11ef-9479-0a002700000b

whsItemStatusId   string   

WHS Item Status Id Example: 32863739-85ed-11ef-9479-0a002700000b

description   string  optional  

description Example: hazaard morning

loggedById   string   

Logged By User Id Example: b493387d-2bf4-1687-799a-590e4eb27463

linkedContactId   string  optional  

Linked Contact Id Example: 1adfc430-f1e7-42ea-8071-b92d77369037

nearMiss   boolean   

Near Miss Example: true

incidentDate   datetime   

Incident Date Example: 2022-01-03 07:50:00

mitigatedDate   datetime  optional  

Mitigated Date Example: 2022-01-03 07:50:00

resolvedDate   datetime  optional  

resolved Date Example: 2022-01-03 07:50:00

costTotal   decimal  optional  

WHS Item Cost Total Example: 280.00

version   integer   

Version number Example: 1543444647

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/whs-items/1/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/whs-items/1/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/whs-items/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the whs item. Example: 1

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

Work Order

Work Order Status
Draft
Locked
In Progress
Completed
Cancelled

List Work Orders

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/work-orders" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/work-orders"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/work-orders

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Work Order

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/work-orders/3" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/work-orders/3"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "workOrder",
        "id": "bf90d214-cbb9-58e8-b3dc-bb9d7624b12e",
        "attributes": {
            "jobId": "b6d87e29-98e5-3f8d-4a3e-eaa15ca0d212",
            "allocationId": "2285e1cd-3c0b-11ea-81c5-02784156a6b6",
            "attachmentId": "2ea48a0a-0797-40d5-a4ba-dee4203cb20b",
            "linkedAttachmentIds": [
                "2ea48a0a-0797-40d5-a4ba-dee4203cb20b",
                "9ee79df3-bcac-4ff2-49f8-3cff82031362"
            ],
            "label": "WO00001",
            "description": "work order description",
            "workOrderStatus": "Draft",
            "assignedId": "8702e32d-67e9-142c-dcb9-1435390ab18a",
            "start": "2018-12-12",
            "end": "2019-01-20",
            "startTime": null,
            "endTime": null,
            "includesTax": 1,
            "tax": "0.00",
            "sellTaxTotal": "0.00",
            "costTaxTotal": "0.00",
            "materialCostTotal": "6850.80",
            "labourCostTotal": "5973.00",
            "materialSellTotal": "1914.00",
            "labourSellTotal": "103.40",
            "sellTotal": 2017.4,
            "costTotal": 12823.8,
            "workOrderItems": [
                {
                    "id": "9ed88642-881a-6ffd-f537-b693b67be563",
                    "trade": "Automatic Gates",
                    "description": "asdfdsfdsfdsaf",
                    "materialQuantity": null,
                    "materialUnit": "ea",
                    "labourQuantity": null,
                    "labourUnit": "ea",
                    "categoryLabel": "Kitchen",
                    "materialCostTotal": "1456.40",
                    "materialSellTotal": "1456.40",
                    "labourCostTotal": "46.20",
                    "labourSellTotal": "46.20",
                    "start": null,
                    "end": null,
                    "includesTax": true,
                    "includesMaterial": true,
                    "includesLabour": true,
                    "tax": "0.00",
                    "version": 1480547175
                },
                {
                    "id": "52a6a219-aa66-a260-bdb6-4ca9e7efe359",
                    "trade": "Automatic Gates",
                    "description": "asdfasdfasdfasfd",
                    "materialQuantity": null,
                    "materialUnit": null,
                    "labourQuantity": null,
                    "labourUnit": null,
                    "categoryLabel": "Kitchen",
                    "materialCostTotal": "457.60",
                    "materialSellTotal": "457.60",
                    "labourCostTotal": "57.20",
                    "labourSellTotal": "57.20",
                    "start": null,
                    "end": null,
                    "includesTax": true,
                    "includesMaterial": true,
                    "includesLabour": true,
                    "tax": "0.00",
                    "version": 1480547175
                }
            ],
            "filterTags": [],
            "createdAt": "2018-12-01 09:06:15",
            "createdBy": "Paul Grant",
            "updatedAt": "2018-12-01 09:07:16",
            "updatedBy": "Paul Grant",
            "version": 1480547236
        }
    }
}

Request   

GET {api_uri}/work-orders/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the work order. Example: 3

Update Work Order

requires authentication

Example request:
curl --request PUT \
    "https://www.primeeco.tech/api.prime/v2/work-orders/3" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/work-orders/3"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request   

PUT {api_uri}/work-orders/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the work order. Example: 3

Body Parameters

attributes   object  optional  
jobId   string   

jobId Example: 40fa1c2d-0a21-4a73-a254-6f0f44a78590

workOrderStatus   string   

Work Order Status Example: Draft

start   string  optional  

Work Order start Date Example: 2018-12-12

startTime   string  optional  

Work Order start Time Example: 09:00:00

end   string  optional  

Work Order End Date Example: 2018-12-13

endTime   string  optional  

Work Order End Time Example: 17:00:00

materialCostTotal   decimal   

Work Order material Cost Total Example: 246.80

labourCostTotal   decimal   

Work Order Labour Cost Total Example: 280.00

costTaxTotal   decimal   

Work Order Tax Cost Total Example: 20.00

version   integer   

Version number Example: 1543444647

Update Filter Tags

requires authentication

Example request:
curl --request PATCH \
    "https://www.primeeco.tech/api.prime/v2/work-orders/3/relationships/filterTags" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json" \

const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/work-orders/3/relationships/filterTags"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH {api_uri}/work-orders/{id}/relationships/filterTags

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the work order. Example: 3

Body Parameters

data   object  optional  
id   string[]   

Filter Tag Ids array. E.g.: ["33144d9c-7983-11ef-a7bd-00fff7b445c2", "331462a4-7983-11ef-a7bd-00fff7b445c2"]

List Upstream Work Orders

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/upstream-work-orders" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/upstream-work-orders"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/upstream-work-orders

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Upstream Work Order

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/upstream-work-orders/et" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/upstream-work-orders/et"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/upstream-work-orders/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   string   

The ID of the upstream work order. Example: et

Workflow

List Workflows

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/workflows" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/workflows"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET {api_uri}/workflows

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

Get Workflow

requires authentication

Example request:
curl --request GET \
    --get "https://www.primeeco.tech/api.prime/v2/workflows/1" \
    --header "Authorization: Bearer {access_token}" \
    --header "Accept: application/vnd.api.v2+json" \
    --header "Content-Type: application/json"
const url = new URL(
    "https://www.primeeco.tech/api.prime/v2/workflows/1"
);

const headers = {
    "Authorization": "Bearer {access_token}",
    "Accept": "application/vnd.api.v2+json",
    "Content-Type": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "type": "workflow",
        "id": "6f12b3c2-d842-e958-865b-ca5804e90d06",
        "attributes": {
            "name": "Desktop Quote",
            "description": "Desktop Quote",
            "active": 1,
            "version": 1488709490
        }
    }
}

Request   

GET {api_uri}/workflows/{id}

Headers

Authorization      

Example: Bearer {access_token}

Accept      

Example: application/vnd.api.v2+json

Content-Type      

Example: application/json

URL Parameters

id   integer   

The ID of the workflow. Example: 1