Contractors.es API Docs (1.0.39)

Download OpenAPI specification:

Sample code:

JavaScript - open test.html in a browser.
NodeJS - Requires installed nodejs/npm.
```
npm install
npm run test
```
PHP 8 - Requires installed composer.
```
composer require contractors-es/api
```
Python 3
```
python test.py
```
n8n community node Install the community node package in your n8n instance - go to settings, community nodes and add:
```
@contractors-es/n8n-nodes-contractors-es
```
Add Contractors.es API credentials in n8n and create a workflow with the Contractors.es node.

All datetimes are handled in UTC. Datetimes returned by the API include time in UTC, and any datetime you pass is treated as UTC. If you provide an ISO-8601 datetime (YYYY-MM-DDTHH:MM+TZ:00), it will be converted to UTC.

Country Api

API documentation for Country Api

Get a list of countries

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"code": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for countries

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "code",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "code",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "code",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"code": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get country

Authorizations:

BearerAuth

path Parameters

country

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"code": "string",
"name": "string",
"id": 0
}
}

State Api

API documentation for State Api

Get a list of states

Authorizations:

BearerAuth

path Parameters

country

required

integer

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"code": "string",
"name": "string",
"country_id": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for states

Authorizations:

BearerAuth

path Parameters

country

required

integer

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "code",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "code",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "code",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"code": "string",
"name": "string",
"country_id": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get state

Authorizations:

BearerAuth

path Parameters

country required	integer
state required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"code": "string",
"name": "string",
"country_id": 0,
"id": 0
}
}

Associate state with country

Authorizations:

BearerAuth

path Parameters

country

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"code": "string",
"name": "string",
"country_id": 0,
"id": 0
}
}

Companies Webhook Api

API documentation for Companies Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Company Api

API documentation for Company Api

Create company

Authorizations:

BearerAuth

Request Body schema: application/json

company_name	string
short_name	string or null
phone	string or null
fax	string or null
email	string or null
web_address	string or null
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
tax_id	string or null
memo	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
}

Get a list of companies

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for companies

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "vendors",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "company_name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "company_name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "company_name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get company

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
}

Update company

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

company_name	string
short_name	string or null
phone	string or null
fax	string or null
email	string or null
web_address	string or null
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
tax_id	string or null
memo	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
}

Delete company

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
}

Restore company

Authorizations:

BearerAuth

path Parameters

company

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
}

Create a batch of companies

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Company)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
]
}

Update a batch of companies

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of companies

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of companies

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"company_name": "string",
"short_name": "string",
"phone": "string",
"fax": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"tax_id": "string",
"memo": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"id": 0
}
]
}

Company Notes Relation Api

API documentation for Company Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

company required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

company required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

company required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

company required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with company

Authorizations:

BearerAuth

path Parameters

company

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from company

Authorizations:

BearerAuth

path Parameters

company required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Company Group Api

API documentation for Company Group Api

Create company group

Authorizations:

BearerAuth

Request Body schema: application/json

slug	string or null
name	string

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

201

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Get a list of company groups

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for company groups

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get company group

Authorizations:

BearerAuth

path Parameters

company_group

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Update company group

Authorizations:

BearerAuth

path Parameters

company_group

required

integer

Request Body schema: application/json

slug	string or null
name	string

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Delete company group

Authorizations:

BearerAuth

path Parameters

company_group

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Restore company group

Authorizations:

BearerAuth

path Parameters

company_group

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Create a batch of company groups

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (CompanyGroup)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"slug": "string",
"name": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Update a batch of company groups

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"slug": "string",
"name": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Delete a batch of company groups

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Restore a batch of company groups

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Company Group Relation Api

API documentation for Company Group Relation Api

Create company group

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

slug	string or null
name	string

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

201

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Get a list of company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get company group

Authorizations:

BearerAuth

path Parameters

company required	integer
group required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Update company group

Authorizations:

BearerAuth

path Parameters

company required	integer
group required	integer

Request Body schema: application/json

slug	string or null
name	string

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Delete company group

Authorizations:

BearerAuth

path Parameters

company required	integer
group required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"id": 0
}
}

Create a batch of company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

Array of objects (CompanyGroup)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"slug": "string",
"name": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Update a batch of company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"slug": "string",
"name": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Delete a batch of company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"id": 0
}
]
}

Attach company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle company groups

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Update pivot

Authorizations:

BearerAuth

path Parameters

company required	integer
group required	integer

Request Body schema: application/json

pivot

object

Pivot fields

Responses

Request samples

Payload

Content type

application/json

{"pivot": { }
}

Response samples

200

Content type

application/json

{"updated": [0
]
}

Company Sales Representative Relation Api

API documentation for Company Sales Representative Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

company required	integer
salesRepresentative required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

company

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Contact Webhook Api

API documentation for Contact Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Contact Api

API documentation for Contact Api

Create contact

Authorizations:

BearerAuth

Request Body schema: application/json

last_name	string
first_name	string
company_id	integer or null
title	string or null
work_phone	string or null
mobile_phone	string or null
email	string or null
web_address	string or null
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
division_id	integer or null
subdivision_id	integer or null
memo	string or null
home_address_1	string or null
home_address_2	string or null
home_city	string or null
home_country_id	integer or null
home_state_id	integer or null
home_postcode	string or null
home_phone	string or null
home_longitude	any
home_latitude	any
ssn	string or null
birth_date	string or null <date>
employment_date	string or null <date>
dismissal_date	string or null <date>
marital_status	integer or null
eligible_for_benefits	string or null
withholdings	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
external_id	string or null
payable_public_holidays	integer or null
payable_vacation_days_per_year	integer or null
payable_vacation_days	any
payable_sick_days_per_year	integer or null
payable_sick_days	any
payable_personal_days_per_year	integer or null
payable_personal_days	any
payable_days_last_update	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24"
}

Response samples

201

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Get a list of contacts

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "employees",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "first_name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "first_name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "first_name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Update contact

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

last_name	string
first_name	string
company_id	integer or null
title	string or null
work_phone	string or null
mobile_phone	string or null
email	string or null
web_address	string or null
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
division_id	integer or null
subdivision_id	integer or null
memo	string or null
home_address_1	string or null
home_address_2	string or null
home_city	string or null
home_country_id	integer or null
home_state_id	integer or null
home_postcode	string or null
home_phone	string or null
home_longitude	any
home_latitude	any
ssn	string or null
birth_date	string or null <date>
employment_date	string or null <date>
dismissal_date	string or null <date>
marital_status	integer or null
eligible_for_benefits	string or null
withholdings	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
external_id	string or null
payable_public_holidays	integer or null
payable_vacation_days_per_year	integer or null
payable_vacation_days	any
payable_sick_days_per_year	integer or null
payable_sick_days	any
payable_personal_days_per_year	integer or null
payable_personal_days	any
payable_days_last_update	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24"
}

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Delete contact

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Restore contact

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Create a batch of contacts

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Contact)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
]
}

Update a batch of contacts

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
]
}

Delete a batch of contacts

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
]
}

Restore a batch of contacts

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
]
}

Contact Notes Relation Api

API documentation for Contact Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

contact required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

contact required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

contact required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

contact required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contact

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contact

Authorizations:

BearerAuth

path Parameters

contact required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Contact Group Api

API documentation for Contact Group Api

Create contact group

Authorizations:

BearerAuth

Request Body schema: application/json

slug	string or null
name	string
filter	integer

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"filter": 0
}

Response samples

201

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Get a list of contact groups

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contact groups

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact group

Authorizations:

BearerAuth

path Parameters

contact_group

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Update contact group

Authorizations:

BearerAuth

path Parameters

contact_group

required

integer

Request Body schema: application/json

slug	string or null
name	string
filter	integer

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"filter": 0
}

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Delete contact group

Authorizations:

BearerAuth

path Parameters

contact_group

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Restore contact group

Authorizations:

BearerAuth

path Parameters

contact_group

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Create a batch of contact groups

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (ContactGroup)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"slug": "string",
"name": "string",
"filter": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Update a batch of contact groups

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"slug": "string",
"name": "string",
"filter": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Delete a batch of contact groups

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Restore a batch of contact groups

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Contact Group Relation Api

API documentation for Contact Group Relation Api

Create contact group

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

slug	string or null
name	string
filter	integer

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"filter": 0
}

Response samples

201

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Get a list of contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact group

Authorizations:

BearerAuth

path Parameters

contact required	integer
group required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Update contact group

Authorizations:

BearerAuth

path Parameters

contact required	integer
group required	integer

Request Body schema: application/json

slug	string or null
name	string
filter	integer

Responses

Request samples

Payload

Content type

application/json

{"slug": "string",
"name": "string",
"filter": 0
}

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Delete contact group

Authorizations:

BearerAuth

path Parameters

contact required	integer
group required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
}

Create a batch of contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

Array of objects (ContactGroup)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"slug": "string",
"name": "string",
"filter": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Update a batch of contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"slug": "string",
"name": "string",
"filter": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Delete a batch of contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"slug": "string",
"name": "string",
"filter": 0,
"id": 0
}
]
}

Attach contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contact groups

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Update pivot

Authorizations:

BearerAuth

path Parameters

contact required	integer
group required	integer

Request Body schema: application/json

pivot

object

Pivot fields

Responses

Request samples

Payload

Content type

application/json

{"pivot": { }
}

Response samples

200

Content type

application/json

{"updated": [0
]
}

Contact Sales Representative Relation Api

API documentation for Contact Sales Representative Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

contact required	integer
salesRepresentative required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

contact

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Meeting Webhook Api

API documentation for Meeting Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Meeting Api

API documentation for Meeting Api

Create meeting

Authorizations:

BearerAuth

Request Body schema: application/json

title	string
schedule_type	string Enum: "date" "datetime"
scheduled_date	string or null <date>
start	string or null
end	string or null
priority	integer
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
recurring	integer
recurring_type	string or null
recurring_interval	integer or null
recurring_month	string or null
recurring_weekday	any
recurring_end	string or null <date>
location_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of meetings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for meetings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "today",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "title",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "title",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "scheduled_date",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get meeting

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
}

Update meeting

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

title	string
schedule_type	string Enum: "date" "datetime"
scheduled_date	string or null <date>
start	string or null
end	string or null
priority	integer
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
recurring	integer
recurring_type	string or null
recurring_interval	integer or null
recurring_month	string or null
recurring_weekday	any
recurring_end	string or null <date>
location_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
}

Delete meeting

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
}

Restore meeting

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of meetings

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Meeting)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of meetings

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of meetings

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of meetings

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"start": "string",
"end": "string",
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"recurring": 0,
"recurring_type": "string",
"recurring_interval": 0,
"recurring_month": "string",
"recurring_weekday": null,
"recurring_end": "2019-08-24",
"location_id": 0,
"external_id": "string",
"id": 0
}
]
}

Meeting Notes Relation Api

API documentation for Meeting Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

meeting required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

meeting required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

meeting required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

meeting required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with meeting

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from meeting

Authorizations:

BearerAuth

path Parameters

meeting required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Meeting Customer Relation Api

API documentation for Meeting Customer Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

meeting required	integer
customer required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Meeting Employee Relation Api

API documentation for Meeting Employee Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

meeting required	integer
employee required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

meeting

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Meeting Location Api

API documentation for Meeting Location Api

Create meeting location

Authorizations:

BearerAuth

Request Body schema: application/json

name	string
active	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"name": "string",
"active": 0,
"id": 0
}
}

Get a list of meeting locations

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for meeting locations

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get meeting location

Authorizations:

BearerAuth

path Parameters

meeting_location

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"active": 0,
"id": 0
}
}

Update meeting location

Authorizations:

BearerAuth

path Parameters

meeting_location

required

integer

Request Body schema: application/json

name	string
active	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"name": "string",
"active": 0,
"id": 0
}
}

Delete meeting location

Authorizations:

BearerAuth

path Parameters

meeting_location

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"active": 0,
"id": 0
}
}

Restore meeting location

Authorizations:

BearerAuth

path Parameters

meeting_location

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"active": 0,
"id": 0
}
}

Create a batch of meeting locations

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (MeetingLocation)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"name": "string",
"active": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
]
}

Update a batch of meeting locations

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"name": "string",
"active": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
]
}

Delete a batch of meeting locations

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
]
}

Restore a batch of meeting locations

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"active": 0,
"id": 0
}
]
}

Task Webhook Api

API documentation for Task Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Task Api

API documentation for Task Api

Create task

Authorizations:

BearerAuth

Request Body schema: application/json

title	string
status	integer
priority	integer
due_type	string Enum: "date" "datetime"
due_date	string or null <date>
due_at	string or null
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of tasks

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for tasks

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "today",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "title",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "title",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "due_date",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get task

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Update task

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

title	string
status	integer
priority	integer
due_type	string Enum: "date" "datetime"
due_date	string or null <date>
due_at	string or null
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Delete task

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Restore task

Authorizations:

BearerAuth

path Parameters

task

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of tasks

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Task)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of tasks

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of tasks

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of tasks

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"status": 0,
"priority": 0,
"due_type": "date",
"due_date": "2019-08-24",
"due_at": "string",
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Task Notes Relation Api

API documentation for Task Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

task required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

task required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

task required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

task required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with task

Authorizations:

BearerAuth

path Parameters

task

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from task

Authorizations:

BearerAuth

path Parameters

task required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Task Customer Relation Api

API documentation for Task Customer Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

task required	integer
customer required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Task Employee Relation Api

API documentation for Task Employee Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

task required	integer
employee required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

task

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Phone Call Webhook Api

API documentation for Phone Call Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Phone Call Api

API documentation for Phone Call Api

Create phone call

Authorizations:

BearerAuth

Request Body schema: application/json

subject	string
schedule_type	string Enum: "date" "datetime"
scheduled_date	string or null <date>
scheduled_at	string or null
contact_company_switch	integer
company_id	integer or null
contact_id	integer or null
mobile_phone_field	string or null
other_customer_name	string or null
other_phone_number	string or null
status	integer
priority	integer
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of phone calls

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for phone calls

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "today",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "subject",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "subject",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "scheduled_date",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get phone call

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Update phone call

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

subject	string
schedule_type	string Enum: "date" "datetime"
scheduled_date	string or null <date>
scheduled_at	string or null
contact_company_switch	integer
company_id	integer or null
contact_id	integer or null
mobile_phone_field	string or null
other_customer_name	string or null
other_phone_number	string or null
status	integer
priority	integer
description	string or null
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
project_status	any
project_bidding_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Delete phone call

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Restore phone call

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of phone calls

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (PhoneCall)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of phone calls

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of phone calls

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of phone calls

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"subject": "string",
"schedule_type": "date",
"scheduled_date": "2019-08-24",
"scheduled_at": "string",
"contact_company_switch": 0,
"company_id": 0,
"contact_id": 0,
"mobile_phone_field": "string",
"other_customer_name": "string",
"other_phone_number": "string",
"status": 0,
"priority": 0,
"description": "string",
"permission": 1,
"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Phone Call Notes Relation Api

API documentation for Phone Call Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with phone call

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from phone call

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Phone Call Employee Relation Api

API documentation for Phone Call Employee Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

phonecall required	integer
employee required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

phonecall

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Warehouse Api

API documentation for Warehouse Api

Create assets warehouse

Authorizations:

BearerAuth

Request Body schema: application/json

name	string
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
active	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
}

Get a list of assets warehouses

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets warehouses

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets warehouse

Authorizations:

BearerAuth

path Parameters

warehouse

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
}

Update assets warehouse

Authorizations:

BearerAuth

path Parameters

warehouse

required

integer

Request Body schema: application/json

name	string
address_1	string or null
address_2	string or null
city	string or null
country_id	integer
state_id	integer or null
postcode	string or null
active	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
}

Delete assets warehouse

Authorizations:

BearerAuth

path Parameters

warehouse

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
}

Restore assets warehouse

Authorizations:

BearerAuth

path Parameters

warehouse

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of assets warehouses

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Warehouse)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets warehouses

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets warehouses

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets warehouses

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"active": 0,
"external_id": "string",
"id": 0
}
]
}

Inventory Api

API documentation for Inventory Api

Create assets inventory

Authorizations:

BearerAuth

Request Body schema: application/json

name	string
barcode	string or null
minimum_threshold	integer or null
requested_quantity	any
quantity	any
available_quantity	any
quantity_unit	string
last_purchase_id	integer or null
category_id	integer or null
memo	string or null
external_id	string or null
warehouse_quantity	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null
}

Response samples

201

Content type

application/json

{"data": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
}

Get a list of assets inventory

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "on_stock",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
}

Update assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

name	string
barcode	string or null
minimum_threshold	integer or null
requested_quantity	any
quantity	any
available_quantity	any
quantity_unit	string
last_purchase_id	integer or null
category_id	integer or null
memo	string or null
external_id	string or null
warehouse_quantity	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null
}

Response samples

200

Content type

application/json

{"data": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
}

Delete assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
}

Restore assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
}

Create a batch of assets inventory

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Inventory)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
]
}

Update a batch of assets inventory

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null
}
}
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
]
}

Delete a batch of assets inventory

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
]
}

Restore a batch of assets inventory

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"barcode": "string",
"minimum_threshold": 0,
"requested_quantity": null,
"quantity": null,
"available_quantity": null,
"quantity_unit": "string",
"last_purchase_id": 0,
"category_id": 0,
"memo": "string",
"external_id": "string",
"warehouse_quantity": null,
"id": 0
}
]
}

Inventory Notes Relation Api

API documentation for Inventory Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

inventory required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

inventory required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

inventory required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

inventory required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets inventory

Authorizations:

BearerAuth

path Parameters

inventory required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Inventory Storage Relation Api

API documentation for Inventory Storage Relation Api

Create assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

inventory_id	integer
type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "type",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "type",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "type",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
storage required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Update assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
storage required	integer

Request Body schema: application/json

inventory_id	integer
type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Delete assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
storage required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Restore assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
storage required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

Array of objects (InventoryStorage)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory storage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Associate assets inventory storage with assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Dissociate assets inventory storage from assets inventory

Authorizations:

BearerAuth

path Parameters

inventory required	integer
storage required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"type": "project",
"warehouse_id": 0,
"project_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Inventory Usage Relation Api

API documentation for Inventory Usage Relation Api

Create assets inventory usage

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

inventory_id	integer
storage_id	integer
quantity	any
record_type	string Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id	integer
purchase_id	integer or null
total_cost	any
total_cost_currency	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "storage_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "storage_id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "created_at",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory usage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
usage required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Update assets inventory usage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
usage required	integer

Request Body schema: application/json

inventory_id	integer
storage_id	integer
quantity	any
record_type	string Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id	integer
purchase_id	integer or null
total_cost	any
total_cost_currency	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Delete assets inventory usage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
usage required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Restore assets inventory usage

Authorizations:

BearerAuth

path Parameters

inventory required	integer
usage required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

Array of objects (InventoryUsage)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory usages

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Associate assets inventory usage with assets inventory

Authorizations:

BearerAuth

path Parameters

inventory

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Dissociate assets inventory usage from assets inventory

Authorizations:

BearerAuth

path Parameters

inventory required	integer
usage required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"inventory_id": 0,
"storage_id": 0,
"quantity": null,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"purchase_id": 0,
"total_cost": null,
"total_cost_currency": "string",
"external_id": "string",
"id": 0
}
}

Inventory Category Api

API documentation for Inventory Category Api

Create assets inventory category

Authorizations:

BearerAuth

Request Body schema: application/json

name	string
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"name": "string",
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory categories

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory categories

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory category

Authorizations:

BearerAuth

path Parameters

inventory_category

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"external_id": "string",
"id": 0
}
}

Update assets inventory category

Authorizations:

BearerAuth

path Parameters

inventory_category

required

integer

Request Body schema: application/json

name	string
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"name": "string",
"external_id": "string",
"id": 0
}
}

Delete assets inventory category

Authorizations:

BearerAuth

path Parameters

inventory_category

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"external_id": "string",
"id": 0
}
}

Restore assets inventory category

Authorizations:

BearerAuth

path Parameters

inventory_category

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory categories

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (InventoryCategory)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"name": "string",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory categories

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"name": "string",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory categories

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory categories

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"external_id": "string",
"id": 0
}
]
}

Inventory Purchase Api

API documentation for Inventory Purchase Api

Create assets inventory purchase

Authorizations:

BearerAuth

Request Body schema: application/json

vendor_id	integer
invoice_no	string or null
delivery_note	string or null
date	string <date>
memo	string or null
status	any Enum: "price_quote" "order" "canceled" "delivered"
invoiced	integer
assign	integer
record_type	string or null Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id	integer or null
storage_type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory purchases

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory purchases

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "invoice_no",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "invoice_no",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "invoice_no",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Update assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

vendor_id	integer
invoice_no	string or null
delivery_note	string or null
date	string <date>
memo	string or null
status	any Enum: "price_quote" "order" "canceled" "delivered"
invoiced	integer
assign	integer
record_type	string or null Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id	integer or null
storage_type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Delete assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Restore assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory purchases

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (InventoryPurchase)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory purchases

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory purchases

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory purchases

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"vendor_id": 0,
"invoice_no": "string",
"delivery_note": "string",
"date": "2019-08-24",
"memo": "string",
"status": "price_quote",
"invoiced": 0,
"assign": 0,
"record_type": "App\\Tenant\\CRM\\Models\\Contact",
"record_id": 0,
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Inventory Purchase Notes Relation Api

API documentation for Inventory Purchase Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Inventory Purchase Row Relation Api

API documentation for Inventory Purchase Row Relation Api

Create assets inventory purchase row

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

purchase_id	integer
inventory_id	integer
storage_id	integer
unit_price	any
unit_price_currency	string or null
quantity	any
used_quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "inventory_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "inventory_id",
"operator": "<",
"value": "string"
}
]
}
]
}

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory purchase row

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
row required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Update assets inventory purchase row

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
row required	integer

Request Body schema: application/json

purchase_id	integer
inventory_id	integer
storage_id	integer
unit_price	any
unit_price_currency	string or null
quantity	any
used_quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Delete assets inventory purchase row

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
row required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Restore assets inventory purchase row

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

Array of objects (InventoryPurchaseRow)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory purchase rows

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
]
}

Associate assets inventory purchase row with assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Dissociate assets inventory purchase row from assets inventory purchase

Authorizations:

BearerAuth

path Parameters

inventory_purchase required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"purchase_id": 0,
"inventory_id": 0,
"storage_id": 0,
"unit_price": null,
"unit_price_currency": "string",
"quantity": null,
"used_quantity": null,
"external_id": "string",
"id": 0
}
}

Inventory Transfer Api

API documentation for Inventory Transfer Api

Create assets inventory transfer

Authorizations:

BearerAuth

Request Body schema: application/json

status	any Enum: "pending" "taken" "delivered"
taken_by	any Enum: "na" "contact" "other"
taken_by_contact_id	integer or null
taken_by_other	string or null
delivered_to	any Enum: "na" "contact" "other"
delivered_to_contact_id	integer or null
delivered_to_other	string or null
from_storage_type	any Enum: "project" "warehouse"
from_warehouse_id	integer or null
from_project_id	integer or null
to_storage_type	any Enum: "project" "warehouse"
to_warehouse_id	integer or null
to_project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory transfers

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory transfers

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "created_at",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "created_at",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "created_at",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
}

Update assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

status	any Enum: "pending" "taken" "delivered"
taken_by	any Enum: "na" "contact" "other"
taken_by_contact_id	integer or null
taken_by_other	string or null
delivered_to	any Enum: "na" "contact" "other"
delivered_to_contact_id	integer or null
delivered_to_other	string or null
from_storage_type	any Enum: "project" "warehouse"
from_warehouse_id	integer or null
from_project_id	integer or null
to_storage_type	any Enum: "project" "warehouse"
to_warehouse_id	integer or null
to_project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
}

Delete assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
}

Restore assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory transfers

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (InventoryTransfer)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory transfers

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory transfers

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory transfers

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"status": "pending",
"taken_by": "na",
"taken_by_contact_id": 0,
"taken_by_other": "string",
"delivered_to": "na",
"delivered_to_contact_id": 0,
"delivered_to_other": "string",
"from_storage_type": "project",
"from_warehouse_id": 0,
"from_project_id": 0,
"to_storage_type": "project",
"to_warehouse_id": 0,
"to_project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Inventory Transfer Notes Relation Api

API documentation for Inventory Transfer Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Inventory Transfer Row Relation Api

API documentation for Inventory Transfer Row Relation Api

Create assets inventory transfer row

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

transfer_id	integer
inventory_id	integer
from_id	integer
to_id	integer
quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "from_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "from_id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "created_at",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory transfer row

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
row required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Update assets inventory transfer row

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
row required	integer

Request Body schema: application/json

transfer_id	integer
inventory_id	integer
from_id	integer
to_id	integer
quantity	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Delete assets inventory transfer row

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
row required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Restore assets inventory transfer row

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

Array of objects (InventoryTransferRow)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory transfer rows

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
]
}

Associate assets inventory transfer row with assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Dissociate assets inventory transfer row from assets inventory transfer

Authorizations:

BearerAuth

path Parameters

inventory_transfer required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"transfer_id": 0,
"inventory_id": 0,
"from_id": 0,
"to_id": 0,
"quantity": null,
"external_id": "string",
"id": 0
}
}

Inventory Stocktaking Api

API documentation for Inventory Stocktaking Api

Create assets inventory stocktaking

Authorizations:

BearerAuth

Request Body schema: application/json

memo	string or null
status	any Enum: "canceled" "in_progress" "done"
storage_type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory stocktakings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory stocktakings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "memo",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "memo",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "created_at",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Update assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

memo	string or null
status	any Enum: "canceled" "in_progress" "done"
storage_type	any Enum: "project" "warehouse"
warehouse_id	integer or null
project_id	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Delete assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Restore assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory stocktakings

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (InventoryStocktaking)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory stocktakings

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory stocktakings

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory stocktakings

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"memo": "string",
"status": "canceled",
"storage_type": "project",
"warehouse_id": 0,
"project_id": 0,
"external_id": "string",
"id": 0
}
]
}

Inventory Stocktaking Notes Relation Api

API documentation for Inventory Stocktaking Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Inventory Stocktaking Row Relation Api

API documentation for Inventory Stocktaking Row Relation Api

Create assets inventory stocktaking row

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

stocktaking_id	integer
inventory_id	integer
storage_id	integer
quantity_before	any
quantity_after	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Get a list of assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "inventory_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "inventory_id",
"operator": "<",
"value": "string"
}
]
}
]
}

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets inventory stocktaking row

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
row required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Update assets inventory stocktaking row

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
row required	integer

Request Body schema: application/json

stocktaking_id	integer
inventory_id	integer
storage_id	integer
quantity_before	any
quantity_after	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Delete assets inventory stocktaking row

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
row required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Restore assets inventory stocktaking row

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Create a batch of assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

Array of objects (InventoryStocktakingRow)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets inventory stocktaking rows

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
]
}

Associate assets inventory stocktaking row with assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Dissociate assets inventory stocktaking row from assets inventory stocktaking

Authorizations:

BearerAuth

path Parameters

inventory_stocktaking required	integer
row required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"stocktaking_id": 0,
"inventory_id": 0,
"storage_id": 0,
"quantity_before": null,
"quantity_after": null,
"external_id": "string",
"id": 0
}
}

Equipment Api

API documentation for Equipment Api

Create assets equipment

Authorizations:

BearerAuth

Request Body schema: application/json

asset_id	string
name	string
serial_no	string or null
warehouse_id	integer or null
warehouse_location	string or null
purchase_price	any
purchase_price_currency	string or null
purchase_date	string <date>
sell_price	any
sell_price_currency	string or null
sell_date	string or null <date>
vendor_id	integer or null
invoice_no	string or null
category_id	integer
meter_value_on_the_purchase	any
meter_value	any
total_units_used_since_the_purchase	any
last_history_id	integer or null
last_service_id	integer or null
memo	string or null
status	any Enum: "active" "lost" "damaged"
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
}

Get a list of assets equipment

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets equipment

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "available",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets equipment

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
}

Update assets equipment

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Request Body schema: application/json

asset_id	string
name	string
serial_no	string or null
warehouse_id	integer or null
warehouse_location	string or null
purchase_price	any
purchase_price_currency	string or null
purchase_date	string <date>
sell_price	any
sell_price_currency	string or null
sell_date	string or null <date>
vendor_id	integer or null
invoice_no	string or null
category_id	integer
meter_value_on_the_purchase	any
meter_value	any
total_units_used_since_the_purchase	any
last_history_id	integer or null
last_service_id	integer or null
memo	string or null
status	any Enum: "active" "lost" "damaged"
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
}

Delete assets equipment

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
}

Restore assets equipment

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
}

Create a batch of assets equipment

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (Equipment)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets equipment

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets equipment

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets equipment

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"asset_id": "string",
"name": "string",
"serial_no": "string",
"warehouse_id": 0,
"warehouse_location": "string",
"purchase_price": null,
"purchase_price_currency": "string",
"purchase_date": "2019-08-24",
"sell_price": null,
"sell_price_currency": "string",
"sell_date": "2019-08-24",
"vendor_id": 0,
"invoice_no": "string",
"category_id": 0,
"meter_value_on_the_purchase": null,
"meter_value": null,
"total_units_used_since_the_purchase": null,
"last_history_id": 0,
"last_service_id": 0,
"memo": "string",
"status": "active",
"external_id": "string",
"id": 0
}
]
}

Equipment Notes Relation Api

API documentation for Equipment Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

equipment required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

equipment required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

equipment required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

equipment required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets equipment

Authorizations:

BearerAuth

path Parameters

equipment

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets equipment

Authorizations:

BearerAuth

path Parameters

equipment required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Equipment Category Api

API documentation for Equipment Category Api

Create assets equipment category

Authorizations:

BearerAuth

Request Body schema: application/json

name	string
cost_per_unit	any
cost_per_unit_currency	string or null
unit	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
}

Get a list of assets equipment categories

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets equipment categories

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets equipment category

Authorizations:

BearerAuth

path Parameters

equipment_category

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
}

Update assets equipment category

Authorizations:

BearerAuth

path Parameters

equipment_category

required

integer

Request Body schema: application/json

name	string
cost_per_unit	any
cost_per_unit_currency	string or null
unit	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
}

Delete assets equipment category

Authorizations:

BearerAuth

path Parameters

equipment_category

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
}

Restore assets equipment category

Authorizations:

BearerAuth

path Parameters

equipment_category

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
}

Create a batch of assets equipment categories

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (EquipmentCategory)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets equipment categories

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets equipment categories

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets equipment categories

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_per_unit": null,
"cost_per_unit_currency": "string",
"unit": "string",
"external_id": "string",
"id": 0
}
]
}

Equipment History Api

API documentation for Equipment History Api

Create assets equipment history

Authorizations:

BearerAuth

Request Body schema: application/json

rented	integer
equipment_id	integer or null
rented_equipment_no	string or null
rented_equipment_description	string or null
rental_vendor_id	integer or null
rental_cost	any
rental_cost_currency	string or null
rental_cost_interval	integer or null
total_cost	any
total_cost_currency	string or null
responsible	any Enum: "employee" "subcontractor" "other"
employee_id	integer or null
subcontractor_id	integer or null
responsible_other	string or null
assign	integer
record_type	string or null Enum: "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\CRM\\Models\\Company"
record_id	integer or null
date	string <date>
est_return_date	string or null <date>
return_date	string or null <date>
returned_in_the_same_condition	integer or null
what_is_wrong	string or null
what_is_wrong_photos	any
meter_value	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
}

Get a list of assets equipment history

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for assets equipment history

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "rented",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "name",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
}

Update assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Request Body schema: application/json

rented	integer
equipment_id	integer or null
rented_equipment_no	string or null
rented_equipment_description	string or null
rental_vendor_id	integer or null
rental_cost	any
rental_cost_currency	string or null
rental_cost_interval	integer or null
total_cost	any
total_cost_currency	string or null
responsible	any Enum: "employee" "subcontractor" "other"
employee_id	integer or null
subcontractor_id	integer or null
responsible_other	string or null
assign	integer
record_type	string or null Enum: "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\CRM\\Models\\Company"
record_id	integer or null
date	string <date>
est_return_date	string or null <date>
return_date	string or null <date>
returned_in_the_same_condition	integer or null
what_is_wrong	string or null
what_is_wrong_photos	any
meter_value	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
}

Delete assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
}

Restore assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
}

Create a batch of assets equipment history

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (EquipmentHistory)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of assets equipment history

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of assets equipment history

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of assets equipment history

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"rented": 0,
"equipment_id": 0,
"rented_equipment_no": "string",
"rented_equipment_description": "string",
"rental_vendor_id": 0,
"rental_cost": null,
"rental_cost_currency": "string",
"rental_cost_interval": 0,
"total_cost": null,
"total_cost_currency": "string",
"responsible": "employee",
"employee_id": 0,
"subcontractor_id": 0,
"responsible_other": "string",
"assign": 0,
"record_type": "App\\Tenant\\Contractor\\Project\\Models\\Project",
"record_id": 0,
"date": "2019-08-24",
"est_return_date": "2019-08-24",
"return_date": "2019-08-24",
"returned_in_the_same_condition": 0,
"what_is_wrong": "string",
"what_is_wrong_photos": null,
"meter_value": null,
"external_id": "string",
"id": 0
}
]
}

Equipment History Notes Relation Api

API documentation for Equipment History Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

equipment_history required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

equipment_history required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

equipment_history required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

equipment_history required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from assets equipment history

Authorizations:

BearerAuth

path Parameters

equipment_history required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Scope Of Work Api

API documentation for Scope Of Work Api

Get a list of contr scope of works

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_code": "string",
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"active": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr scope of works

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "id",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"name": "string",
"cost_code": "string",
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"active": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr scope of work

Authorizations:

BearerAuth

path Parameters

scope_of_work

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"name": "string",
"cost_code": "string",
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"active": 0,
"id": 0
}
}

Job Visit Webhook Api

API documentation for Job Visit Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Job Visit Api

API documentation for Job Visit Api

Create contr job visit

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectBidding" "visitors" "visitType"

Request Body schema: application/json

project_status	any
project_bidding_id	integer or null
project_id	integer or null
status	integer
visit_date	string
visit_end	string or null
visit_type_id	integer
reason_for_visit	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
}

Get a list of contr job visits

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectBidding" "visitors" "visitType"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr job visits

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectBidding" "visitors" "visitType"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "projectBiddings",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "project_status",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "project_status",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "visit_date",
"direction": "asc"
}
],
"includes": [{"relation": "project"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectBidding" "visitors" "visitType"

Responses

Response samples

200

Content type

application/json

{"data": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
}

Update contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Request Body schema: application/json

project_status	any
project_bidding_id	integer or null
project_id	integer or null
status	integer
visit_date	string
visit_end	string or null
visit_type_id	integer
reason_for_visit	string or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
}

Delete contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

force	boolean
include	string Enum: "project" "projectBidding" "visitors" "visitType"

Responses

Response samples

200

Content type

application/json

{"data": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
}

Restore contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

include

string

Enum: "project" "projectBidding" "visitors" "visitType"

Responses

Response samples

200

Content type

application/json

{"data": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
}

Create a batch of contr job visits

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectBidding" "visitors" "visitType"

Request Body schema: application/json

Array of objects (JobVisit)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr job visits

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr job visits

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "project" "projectBidding" "visitors" "visitType"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr job visits

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectBidding" "visitors" "visitType"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_status": null,
"project_bidding_id": 0,
"project_id": 0,
"status": 0,
"visit_date": "string",
"visit_end": "string",
"visit_type_id": 0,
"reason_for_visit": "string",
"external_id": "string",
"id": 0
}
]
}

Job Visit Notes Relation Api

API documentation for Job Visit Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

job_visit required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

job_visit required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

job_visit required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

job_visit required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr job visit

Authorizations:

BearerAuth

path Parameters

job_visit required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Project Webhook Api

API documentation for Project Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Project Api

API documentation for Project Api

Create contr project

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Request Body schema: application/json

project_bidding_id	integer or null
project_proposal_id	integer or null
bid_no	string or null
acctg_job_no	string or null
project_name	string
customer_type	integer Enum: 1 2 1 - Company, 2 - Contact
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
contract_amount	any
contract_amount_currency	string or null
	Array of objects
status	any Enum: "awarded" "contract_prepared" "contract_signed" "preconstruction_documentation_pending" "preconstruction_documentation_in_progress" "preconstruction_documentation_completed" "preconstruction_documentation_verified" "preconstruction_documentation_sent_to_customer" "preconstruction_documentation_approved_by_customer" "in_progress" "work_on_hold" "issue" "completed" "closed" "canceled"
description	string or null
sales_representative_id	integer or null
gc_job	integer or null
gc_job_no	string or null
start_date	string or null <date>
restart_date	string or null <date>
est_end_date	string or null <date>
plans	any
drawings_recvd	integer or null
drawings_recvd_date	string or null <date>
contract_date	string or null <date>
preconstruction_documentation_due_date	string or null <date>
preconstruction_documentation_approved_sent	integer or null
preconstruction_documentation_approved_sent_date	string or null <date>
submittal_package_sent_date	string or null <date>
msds_product_data_date	string or null <date>
samples_ordered_date	string or null <date>
samples_received_date	string or null <date>
samples_sent_date	string or null <date>
samples_approved_date	string or null <date>
submittal_package_sent	integer
msds_product_data	integer
samples_ordered	integer
samples_received	integer
samples_sent	integer
samples_approved	integer
longitude	any
latitude	any
insurance_cert_req	integer or null
p_and_l_gp	string or null
billed_in_full	integer or null
billed_in_full_date	string or null <date>
job_progress	integer or null
tm	integer or null
tm_hour_rate	any
tm_hour_rate_currency	string or null
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Get a list of contr projects

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr projects

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "active",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "project_name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "project_name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "project_name",
"direction": "asc"
}
],
"includes": [{"relation": "projectBidding"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Update contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

project_bidding_id	integer or null
project_proposal_id	integer or null
bid_no	string or null
acctg_job_no	string or null
project_name	string
customer_type	integer Enum: 1 2 1 - Company, 2 - Contact
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
contract_amount	any
contract_amount_currency	string or null
	Array of objects
status	any Enum: "awarded" "contract_prepared" "contract_signed" "preconstruction_documentation_pending" "preconstruction_documentation_in_progress" "preconstruction_documentation_completed" "preconstruction_documentation_verified" "preconstruction_documentation_sent_to_customer" "preconstruction_documentation_approved_by_customer" "in_progress" "work_on_hold" "issue" "completed" "closed" "canceled"
description	string or null
sales_representative_id	integer or null
gc_job	integer or null
gc_job_no	string or null
start_date	string or null <date>
restart_date	string or null <date>
est_end_date	string or null <date>
plans	any
drawings_recvd	integer or null
drawings_recvd_date	string or null <date>
contract_date	string or null <date>
preconstruction_documentation_due_date	string or null <date>
preconstruction_documentation_approved_sent	integer or null
preconstruction_documentation_approved_sent_date	string or null <date>
submittal_package_sent_date	string or null <date>
msds_product_data_date	string or null <date>
samples_ordered_date	string or null <date>
samples_received_date	string or null <date>
samples_sent_date	string or null <date>
samples_approved_date	string or null <date>
submittal_package_sent	integer
msds_product_data	integer
samples_ordered	integer
samples_received	integer
samples_sent	integer
samples_approved	integer
longitude	any
latitude	any
insurance_cert_req	integer or null
p_and_l_gp	string or null
billed_in_full	integer or null
billed_in_full_date	string or null <date>
job_progress	integer or null
tm	integer or null
tm_hour_rate	any
tm_hour_rate_currency	string or null
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Delete contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

force	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Restore contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Create a batch of contr projects

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Request Body schema: application/json

Array of objects (Project)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr projects

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr projects

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr projects

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "projectBidding" "projectProposal" "scopesOfWork" "materials"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Project Notes Relation Api

API documentation for Project Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

project required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

project required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

project required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

project required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr project

Authorizations:

BearerAuth

path Parameters

project required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Project Contacts Relation Api

API documentation for Project Contacts Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
contact required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Architects Relation Api

API documentation for Project Architects Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
architect required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Engineers Relation Api

API documentation for Project Engineers Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
engineer required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Project Managers Relation Api

API documentation for Project Project Managers Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
project_manager required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Estimators Relation Api

API documentation for Project Estimators Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
estimator required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Roadmen Relation Api

API documentation for Project Roadmen Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
roadman required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Foremen Relation Api

API documentation for Project Foremen Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
foreman required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Legal Support Relation Api

API documentation for Project Legal Support Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
legal_support required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Building Inspectors Relation Api

API documentation for Project Building Inspectors Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
building_inspector required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Gc Estimators Relation Api

API documentation for Project Gc Estimators Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
gc_estimator required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Gc Project Managers Relation Api

API documentation for Project Gc Project Managers Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
gc_project_manager required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Gc Superintendents Relation Api

API documentation for Project Gc Superintendents Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project required	integer
gc_superintendent required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Scopes Of Work Relation Api

API documentation for Project Scopes Of Work Relation Api

Create contr project scope of work

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment	any
est_equipment_currency	string or null
est_equipment_per_unit_currency	string or null
description	string or null
scope_progress	integer or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Get a list of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project scope of work

Authorizations:

BearerAuth

path Parameters

project required	integer
scopes_of_work required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Update contr project scope of work

Authorizations:

BearerAuth

path Parameters

project required	integer
scopes_of_work required	integer

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment	any
est_equipment_currency	string or null
est_equipment_per_unit_currency	string or null
description	string or null
scope_progress	integer or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Delete contr project scope of work

Authorizations:

BearerAuth

path Parameters

project required	integer
scopes_of_work required	integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Restore contr project scope of work

Authorizations:

BearerAuth

path Parameters

project required	integer
scopes_of_work required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Create a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

Array of objects (ProjectScopeOfWork)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Update a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Delete a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Restore a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Associate contr project scope of work with contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Dissociate contr project scope of work from contr project

Authorizations:

BearerAuth

path Parameters

project required	integer
scopes_of_work required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Project Change Orders Relation Api

API documentation for Project Change Orders Relation Api

Create contr change order

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Request Body schema: application/json

co_number	string
gc_co_number	string or null
title	string
type	integer
project_id	integer
estimator_id	integer or null
description	string or null
date	string <date>
status	any Enum: "draft" "verified" "sent" "disapproved" "approved" "completed"
approved_date	string or null <date>
billed_in_full	integer
billed_in_full_date	string or null <date>
markup_ratio	any
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
co_amount	any
co_amount_currency	string or null
contract_days_added	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Get a list of contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "disapproved",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "co_number",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "co_number",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "co_number",
"direction": "asc"
}
],
"includes": [{"relation": "materials"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr change order

Authorizations:

BearerAuth

path Parameters

project required	integer
change_order required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Update contr change order

Authorizations:

BearerAuth

path Parameters

project required	integer
change_order required	integer

Request Body schema: application/json

co_number	string
gc_co_number	string or null
title	string
type	integer
project_id	integer
estimator_id	integer or null
description	string or null
date	string <date>
status	any Enum: "draft" "verified" "sent" "disapproved" "approved" "completed"
approved_date	string or null <date>
billed_in_full	integer
billed_in_full_date	string or null <date>
markup_ratio	any
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
co_amount	any
co_amount_currency	string or null
contract_days_added	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Delete contr change order

Authorizations:

BearerAuth

path Parameters

project required	integer
change_order required	integer

query Parameters

force	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Restore contr change order

Authorizations:

BearerAuth

path Parameters

project required	integer
change_order required	integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Request Body schema: application/json

Array of objects (ChangeOrder)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

force	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr change orders

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Associate contr change order with contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Dissociate contr change order from contr project

Authorizations:

BearerAuth

path Parameters

project required	integer
change_order required	integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator" "invoices"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Project Stage Webhook Api

API documentation for Project Stage Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Project Stage Api

API documentation for Project Stage Api

Create contr project stage

Authorizations:

BearerAuth

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

project_id	integer
stage_number	integer
name	string
estimated_start_date	string or null <date>
estimated_end_date	string or null <date>
estimated_duration_days	integer or null
status	any Enum: "awaiting_prepayment" "pending" "completed" "protocol_sent" "accepted_conditionally" "completed_fixes" "protocol_sent_after_fixes" "accepted" "declined"
prepayment_percentage	any
prepayment_received_date	string or null <date>
stage_amount	any
stage_amount_currency	string or null
acceptation_notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Get a list of contr project stages

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project stages

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	object
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"search": {"value": "string",
"case_sensitive": true
},
"sort": [{"field": "stage_number",
"direction": "asc"
}
],
"includes": [{"relation": "scopesOfWork"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Update contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

project_id	integer
stage_number	integer
name	string
estimated_start_date	string or null <date>
estimated_end_date	string or null <date>
estimated_duration_days	integer or null
status	any Enum: "awaiting_prepayment" "pending" "completed" "protocol_sent" "accepted_conditionally" "completed_fixes" "protocol_sent_after_fixes" "accepted" "declined"
prepayment_percentage	any
prepayment_received_date	string or null <date>
stage_amount	any
stage_amount_currency	string or null
acceptation_notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Delete contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

force	boolean
include	string Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Restore contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

include

string

Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Create a batch of contr project stages

Authorizations:

BearerAuth

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

Array of objects (ProjectStage)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Update a batch of contr project stages

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Delete a batch of contr project stages

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Value: "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Restore a batch of contr project stages

Authorizations:

BearerAuth

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Project Stage Notes Relation Api

API documentation for Project Stage Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Project Stages Relation Api

API documentation for Project Stages Relation Api

Create contr project stage

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

project_id	integer
stage_number	integer
name	string
estimated_start_date	string or null <date>
estimated_end_date	string or null <date>
estimated_duration_days	integer or null
status	any Enum: "awaiting_prepayment" "pending" "completed" "protocol_sent" "accepted_conditionally" "completed_fixes" "protocol_sent_after_fixes" "accepted" "declined"
prepayment_percentage	any
prepayment_received_date	string or null <date>
stage_amount	any
stage_amount_currency	string or null
acceptation_notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Get a list of contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "name",
"operator": "<",
"value": "string"
}
]
}
],
"search": {"value": "string",
"case_sensitive": true
},
"sort": [{"field": "stage_number",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project stage

Authorizations:

BearerAuth

path Parameters

project required	integer
stage required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Update contr project stage

Authorizations:

BearerAuth

path Parameters

project required	integer
stage required	integer

Request Body schema: application/json

project_id	integer
stage_number	integer
name	string
estimated_start_date	string or null <date>
estimated_end_date	string or null <date>
estimated_duration_days	integer or null
status	any Enum: "awaiting_prepayment" "pending" "completed" "protocol_sent" "accepted_conditionally" "completed_fixes" "protocol_sent_after_fixes" "accepted" "declined"
prepayment_percentage	any
prepayment_received_date	string or null <date>
stage_amount	any
stage_amount_currency	string or null
acceptation_notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Delete contr project stage

Authorizations:

BearerAuth

path Parameters

project required	integer
stage required	integer

query Parameters

force	boolean
include	string Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Restore contr project stage

Authorizations:

BearerAuth

path Parameters

project required	integer
stage required	integer

query Parameters

include

string

Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Create a batch of contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

Array of objects (ProjectStage)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Update a batch of contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Delete a batch of contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

force	boolean
include	string Value: "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Restore a batch of contr project stages

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
]
}

Associate contr project stage with contr project

Authorizations:

BearerAuth

path Parameters

project

required

integer

query Parameters

include

string

Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Dissociate contr project stage from contr project

Authorizations:

BearerAuth

path Parameters

project required	integer
stage required	integer

query Parameters

include

string

Value: "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"stage_number": 0,
"name": "string",
"estimated_start_date": "2019-08-24",
"estimated_end_date": "2019-08-24",
"estimated_duration_days": 0,
"status": "awaiting_prepayment",
"prepayment_percentage": null,
"prepayment_received_date": "2019-08-24",
"stage_amount": null,
"stage_amount_currency": "string",
"acceptation_notes": "string",
"id": 0,
"group": "string",
"stage_progress": 0,
"completion_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "string",
"created_by": 0,
"updated_by": 0,
"deleted_by": 0
}
}

Project Stage Scopes Of Work Relation Api

API documentation for Project Stage Scopes Of Work Relation Api

Create contr project scope of work

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment	any
est_equipment_currency	string or null
est_equipment_per_unit_currency	string or null
description	string or null
scope_progress	integer or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Get a list of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project scope of work

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
scopes_of_work required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Update contr project scope of work

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
scopes_of_work required	integer

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment	any
est_equipment_currency	string or null
est_equipment_per_unit_currency	string or null
description	string or null
scope_progress	integer or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Delete contr project scope of work

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
scopes_of_work required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Restore contr project scope of work

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
scopes_of_work required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Create a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

Array of objects (ProjectScopeOfWork)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Update a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Delete a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Restore a batch of contr project scope of works

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
]
}

Associate contr project scope of work with contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Dissociate contr project scope of work from contr project stage

Authorizations:

BearerAuth

path Parameters

project_stage required	integer
scopes_of_work required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment": null,
"est_equipment_currency": "string",
"est_equipment_per_unit_currency": "string",
"description": "string",
"scope_progress": 0,
"id": 0
}
}

Project Bidding Webhook Api

API documentation for Project Bidding Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Project Bidding Api

API documentation for Project Bidding Api

Create contr project bidding

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Request Body schema: application/json

bid_no	string or null
project_name	string
customer_type	integer
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
sales_representative_id	integer or null
bid_invitation_recvd	integer or null
bid_invitation_recvd_date	string or null <date>
description	string or null
status	any Enum: "initial_planning" "itb_received" "estimation" "estimation_submitted" "bid_on_hold" "not_bid" "proposal_submitted" "job_lost" "awarded" "canceled"
estimation_due_date	string or null <date>
estimation_submitted	integer
estimation_date	string or null <date>
estimation_amount	any
estimation_amount_currency	string or null
proposal_due_date	string or null <date>
award_date	string or null <date>
lost_date	string or null <date>
plans	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Get a list of contr project biddings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project biddings

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "active",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "project_name",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "project_name",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "project_name",
"direction": "asc"
}
],
"includes": [{"relation": "proposals"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Responses

Response samples

200

Content type

application/json

{"data": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Update contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

bid_no	string or null
project_name	string
customer_type	integer
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
sales_representative_id	integer or null
bid_invitation_recvd	integer or null
bid_invitation_recvd_date	string or null <date>
description	string or null
status	any Enum: "initial_planning" "itb_received" "estimation" "estimation_submitted" "bid_on_hold" "not_bid" "proposal_submitted" "job_lost" "awarded" "canceled"
estimation_due_date	string or null <date>
estimation_submitted	integer
estimation_date	string or null <date>
estimation_amount	any
estimation_amount_currency	string or null
proposal_due_date	string or null <date>
award_date	string or null <date>
lost_date	string or null <date>
plans	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Delete contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

force	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Responses

Response samples

200

Content type

application/json

{"data": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Restore contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Responses

Response samples

200

Content type

application/json

{"data": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Create a batch of contr project biddings

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Request Body schema: application/json

Array of objects (ProjectBidding)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr project biddings

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr project biddings

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr project biddings

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "company" "contacts" "jobType" "referrer" "proposals" "filledProposals" "projects"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"bid_no": "string",
"project_name": "string",
"customer_type": 0,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"sales_representative_id": 0,
"bid_invitation_recvd": 0,
"bid_invitation_recvd_date": "2019-08-24",
"description": "string",
"status": "initial_planning",
"estimation_due_date": "2019-08-24",
"estimation_submitted": 0,
"estimation_date": "2019-08-24",
"estimation_amount": null,
"estimation_amount_currency": "string",
"proposal_due_date": "2019-08-24",
"award_date": "2019-08-24",
"lost_date": "2019-08-24",
"plans": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Project Bidding Notes Relation Api

API documentation for Project Bidding Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Project Bidding Contacts Relation Api

API documentation for Project Bidding Contacts Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
contact required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Bidding Estimators Relation Api

API documentation for Project Bidding Estimators Relation Api

Get a list of contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contact

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
estimator required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"last_name": "string",
"first_name": "string",
"company_id": 0,
"title": "string",
"work_phone": "string",
"mobile_phone": "string",
"email": "string",
"web_address": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"division_id": 0,
"subdivision_id": 0,
"memo": "string",
"home_address_1": "string",
"home_address_2": "string",
"home_city": "string",
"home_country_id": 0,
"home_state_id": 0,
"home_postcode": "string",
"home_phone": "string",
"home_longitude": null,
"home_latitude": null,
"ssn": "string",
"birth_date": "2019-08-24",
"employment_date": "2019-08-24",
"dismissal_date": "2019-08-24",
"marital_status": 0,
"eligible_for_benefits": "string",
"withholdings": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"permission": 1,
"external_id": "string",
"payable_public_holidays": 0,
"payable_vacation_days_per_year": 0,
"payable_vacation_days": null,
"payable_sick_days_per_year": 0,
"payable_sick_days": null,
"payable_personal_days_per_year": 0,
"payable_personal_days": null,
"payable_days_last_update": "2019-08-24",
"id": 0
}
}

Attach contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
]
}

Detach contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"detached": [0
]
}

Sync contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
],
"updated": [0
]
}

Toggle contacts

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"resources": [{ }
]
}

Response samples

200

Content type

application/json

{"attached": [0
],
"detached": [0
]
}

Project Bidding Proposals Relation Api

API documentation for Project Bidding Proposals Relation Api

Create contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Get a list of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "fields" "materials" "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "fields" "materials" "scopesOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
proposal required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "fields" "materials" "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Update contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
proposal required	integer

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Delete contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
proposal required	integer

query Parameters

force	boolean
include	string Enum: "fields" "materials" "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Restore contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
proposal required	integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Create a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Request Body schema: application/json

Array of objects (ProjectProposal)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

force	boolean
include	string Enum: "fields" "materials" "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Associate contr project proposal with contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Dissociate contr project proposal from contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
proposal required	integer

query Parameters

include

string

Enum: "fields" "materials" "scopesOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Project Bidding Filled Proposals Relation Api

API documentation for Project Bidding Filled Proposals Relation Api

Create contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Get a list of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
filled_proposal required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Update contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
filled_proposal required	integer

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Delete contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
filled_proposal required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Restore contr project proposal

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
filled_proposal required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Create a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

Array of objects (ProjectProposal)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr project proposals

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Associate contr project proposal with contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Dissociate contr project proposal from contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
filled_proposal required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Project Bidding Projects Relation Api

API documentation for Project Bidding Projects Relation Api

Create contr project

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

project_bidding_id	integer or null
project_proposal_id	integer or null
bid_no	string or null
acctg_job_no	string or null
project_name	string
customer_type	integer Enum: 1 2 1 - Company, 2 - Contact
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
contract_amount	any
contract_amount_currency	string or null
	Array of objects
status	any Enum: "awarded" "contract_prepared" "contract_signed" "preconstruction_documentation_pending" "preconstruction_documentation_in_progress" "preconstruction_documentation_completed" "preconstruction_documentation_verified" "preconstruction_documentation_sent_to_customer" "preconstruction_documentation_approved_by_customer" "in_progress" "work_on_hold" "issue" "completed" "closed" "canceled"
description	string or null
sales_representative_id	integer or null
gc_job	integer or null
gc_job_no	string or null
start_date	string or null <date>
restart_date	string or null <date>
est_end_date	string or null <date>
plans	any
drawings_recvd	integer or null
drawings_recvd_date	string or null <date>
contract_date	string or null <date>
preconstruction_documentation_due_date	string or null <date>
preconstruction_documentation_approved_sent	integer or null
preconstruction_documentation_approved_sent_date	string or null <date>
submittal_package_sent_date	string or null <date>
msds_product_data_date	string or null <date>
samples_ordered_date	string or null <date>
samples_received_date	string or null <date>
samples_sent_date	string or null <date>
samples_approved_date	string or null <date>
submittal_package_sent	integer
msds_product_data	integer
samples_ordered	integer
samples_received	integer
samples_sent	integer
samples_approved	integer
longitude	any
latitude	any
insurance_cert_req	integer or null
p_and_l_gp	string or null
billed_in_full	integer or null
billed_in_full_date	string or null <date>
job_progress	integer or null
tm	integer or null
tm_hour_rate	any
tm_hour_rate_currency	string or null
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Get a list of contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
project required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Update contr project

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
project required	integer

Request Body schema: application/json

project_bidding_id	integer or null
project_proposal_id	integer or null
bid_no	string or null
acctg_job_no	string or null
project_name	string
customer_type	integer Enum: 1 2 1 - Company, 2 - Contact
company_id	integer or null
project_address_1	string or null
project_address_2	string or null
city	string or null
country_id	integer or null
state_id	integer or null
postcode	string or null
job_type_id	integer or null
referrer_id	integer or null
contract_amount	any
contract_amount_currency	string or null
	Array of objects
status	any Enum: "awarded" "contract_prepared" "contract_signed" "preconstruction_documentation_pending" "preconstruction_documentation_in_progress" "preconstruction_documentation_completed" "preconstruction_documentation_verified" "preconstruction_documentation_sent_to_customer" "preconstruction_documentation_approved_by_customer" "in_progress" "work_on_hold" "issue" "completed" "closed" "canceled"
description	string or null
sales_representative_id	integer or null
gc_job	integer or null
gc_job_no	string or null
start_date	string or null <date>
restart_date	string or null <date>
est_end_date	string or null <date>
plans	any
drawings_recvd	integer or null
drawings_recvd_date	string or null <date>
contract_date	string or null <date>
preconstruction_documentation_due_date	string or null <date>
preconstruction_documentation_approved_sent	integer or null
preconstruction_documentation_approved_sent_date	string or null <date>
submittal_package_sent_date	string or null <date>
msds_product_data_date	string or null <date>
samples_ordered_date	string or null <date>
samples_received_date	string or null <date>
samples_sent_date	string or null <date>
samples_approved_date	string or null <date>
submittal_package_sent	integer
msds_product_data	integer
samples_ordered	integer
samples_received	integer
samples_sent	integer
samples_approved	integer
longitude	any
latitude	any
insurance_cert_req	integer or null
p_and_l_gp	string or null
billed_in_full	integer or null
billed_in_full_date	string or null <date>
job_progress	integer or null
tm	integer or null
tm_hour_rate	any
tm_hour_rate_currency	string or null
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
priority	integer
manday_hours	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Delete contr project

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
project required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Restore contr project

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
project required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Create a batch of contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

Array of objects (Project)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr projects

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
]
}

Associate contr project with contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Dissociate contr project from contr project bidding

Authorizations:

BearerAuth

path Parameters

project_bidding required	integer
project required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_bidding_id": 0,
"project_proposal_id": 0,
"bid_no": "string",
"acctg_job_no": "string",
"project_name": "string",
"customer_type": 1,
"company_id": 0,
"project_address_1": "string",
"project_address_2": "string",
"city": "string",
"country_id": 0,
"state_id": 0,
"postcode": "string",
"job_type_id": 0,
"referrer_id": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"status": "awarded",
"description": "string",
"sales_representative_id": 0,
"gc_job": 0,
"gc_job_no": "string",
"start_date": "2019-08-24",
"restart_date": "2019-08-24",
"est_end_date": "2019-08-24",
"plans": null,
"drawings_recvd": 0,
"drawings_recvd_date": "2019-08-24",
"contract_date": "2019-08-24",
"preconstruction_documentation_due_date": "2019-08-24",
"preconstruction_documentation_approved_sent": 0,
"preconstruction_documentation_approved_sent_date": "2019-08-24",
"submittal_package_sent_date": "2019-08-24",
"msds_product_data_date": "2019-08-24",
"samples_ordered_date": "2019-08-24",
"samples_received_date": "2019-08-24",
"samples_sent_date": "2019-08-24",
"samples_approved_date": "2019-08-24",
"submittal_package_sent": 0,
"msds_product_data": 0,
"samples_ordered": 0,
"samples_received": 0,
"samples_sent": 0,
"samples_approved": 0,
"longitude": null,
"latitude": null,
"insurance_cert_req": 0,
"p_and_l_gp": "string",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"job_progress": 0,
"tm": 0,
"tm_hour_rate": null,
"tm_hour_rate_currency": "string",
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"priority": 0,
"manday_hours": null,
"external_id": "string",
"id": 0
}
}

Project Proposal Webhook Api

API documentation for Project Proposal Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Project Proposal Api

API documentation for Project Proposal Api

Create contr project proposal

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Get a list of contr project proposals

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project proposals

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "submitted",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "description",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "description",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "description",
"direction": "asc"
}
],
"includes": [{"relation": "projectBidding"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Update contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

proposal_no	integer
description	string or null
project_bidding_id	integer
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
markup_ratio	any
submitted	integer
proposal_date	string or null <date>
proposal_amount	any
proposal_amount_currency	string or null
	Array of objects
awarded	integer
award_date	string or null <date>
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Delete contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

force	boolean
include	string Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Restore contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

include

string

Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

200

Content type

application/json

{"data": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
}

Create a batch of contr project proposals

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Request Body schema: application/json

Array of objects (ProjectProposal)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr project proposals

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr project proposals

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr project proposals

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"proposal_no": 0,
"description": "string",
"project_bidding_id": 0,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"markup_ratio": null,
"submitted": 0,
"proposal_date": "2019-08-24",
"proposal_amount": null,
"proposal_amount_currency": "string",
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"awarded": 0,
"award_date": "2019-08-24",
"external_id": "string",
"id": 0
}
]
}

Project Proposal Notes Relation Api

API documentation for Project Proposal Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Project Proposal Scope Of Work Relation Api

API documentation for Project Proposal Scope Of Work Relation Api

Create contr project proposal scope of work

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

project_proposal_id	integer
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment_per_unit_currency	string or null
est_equipment	any
est_equipment_currency	string or null
description	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Get a list of contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr project proposal scope of work

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
scopes_of_work required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Update contr project proposal scope of work

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
scopes_of_work required	integer

Request Body schema: application/json

project_proposal_id	integer
scope_of_work_id	integer
calculate_by	integer
hour_rate	any
hour_rate_currency	string or null
unit	string or null
quantity	any
unit_rate	any
unit_rate_currency	string or null
est_hours_per_unit	any
est_mandays	any
est_labor	any
est_labor_currency	string or null
material	integer
est_material_per_unit	any
est_material_per_unit_currency	string or null
est_material	any
est_material_currency	string or null
equipment	integer
est_equipment_per_unit	any
est_equipment_per_unit_currency	string or null
est_equipment	any
est_equipment_currency	string or null
description	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Delete contr project proposal scope of work

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
scopes_of_work required	integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Restore contr project proposal scope of work

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
scopes_of_work required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Create a batch of contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

Array of objects (ProjectProposalScopeOfWork)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
]
}

Update a batch of contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
]
}

Delete a batch of contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
]
}

Restore a batch of contr project proposal scope of works

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
]
}

Associate contr project proposal scope of work with contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Dissociate contr project proposal scope of work from contr project proposal

Authorizations:

BearerAuth

path Parameters

project_proposal required	integer
scopes_of_work required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"project_proposal_id": 0,
"scope_of_work_id": 0,
"calculate_by": 0,
"hour_rate": null,
"hour_rate_currency": "string",
"unit": "string",
"quantity": null,
"unit_rate": null,
"unit_rate_currency": "string",
"est_hours_per_unit": null,
"est_mandays": null,
"est_labor": null,
"est_labor_currency": "string",
"material": 0,
"est_material_per_unit": null,
"est_material_per_unit_currency": "string",
"est_material": null,
"est_material_currency": "string",
"equipment": 0,
"est_equipment_per_unit": null,
"est_equipment_per_unit_currency": "string",
"est_equipment": null,
"est_equipment_currency": "string",
"description": "string",
"id": 0
}
}

Invoice Webhook Api

API documentation for Invoice Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Invoice Api

API documentation for Invoice Api

Create contr invoice

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectStage" "finalInvoice"

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
type	any Enum: "partial" "prepayment" "final"
invoice_no	string
date	string <date>
due_date	string <date>
description	string
footer	any
	Array of objects
amount	any
amount_currency	string
order_amount	any
order_amount_currency	string or null
paid_amount	any
document_paid_amount	any
document_paid_amount_currency	string
paid_amount_currency	string
paid_in_full	integer
paid_in_full_date	string or null <date>
update_progress	integer
job_progress	integer or null
external_id	string or null
prepayment_ids	Array of integers Array of prepayment invoice IDs associated with this final invoice. Required when type is final, prohibited otherwise.

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
]
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
}

Get a list of contr invoices

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectStage" "finalInvoice"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr invoices

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectStage" "finalInvoice"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "myProjects",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "project_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "project_id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "date",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "project" "projectStage" "finalInvoice"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
}

Update contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

project_id	integer
project_stage_id	integer or null
type	any Enum: "partial" "prepayment" "final"
invoice_no	string
date	string <date>
due_date	string <date>
description	string
footer	any
	Array of objects
amount	any
amount_currency	string
order_amount	any
order_amount_currency	string or null
paid_amount	any
document_paid_amount	any
document_paid_amount_currency	string
paid_amount_currency	string
paid_in_full	integer
paid_in_full_date	string or null <date>
update_progress	integer
job_progress	integer or null
external_id	string or null
prepayment_ids	Array of integers Array of prepayment invoice IDs associated with this final invoice. Required when type is final, prohibited otherwise.

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
]
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
}

Delete contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

force	boolean
include	string Enum: "project" "projectStage" "finalInvoice"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
}

Restore contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

include

string

Enum: "project" "projectStage" "finalInvoice"

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
}

Create a batch of contr invoices

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectStage" "finalInvoice"

Request Body schema: application/json

Array of objects (Invoice)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
]
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
]
}

Update a batch of contr invoices

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
]
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
]
}

Delete a batch of contr invoices

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "project" "projectStage" "finalInvoice"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
]
}

Restore a batch of contr invoices

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "project" "projectStage" "finalInvoice"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"project_stage_id": 0,
"type": "partial",
"invoice_no": "string",
"date": "2019-08-24",
"due_date": "2019-08-24",
"description": "string",
"footer": null,
"tax_rates": [{"percent": 0.1,
"rate": 0.1
}
],
"amount": null,
"amount_currency": "string",
"order_amount": null,
"order_amount_currency": "string",
"paid_amount": null,
"document_paid_amount": null,
"document_paid_amount_currency": "string",
"paid_amount_currency": "string",
"paid_in_full": 0,
"paid_in_full_date": "2019-08-24",
"update_progress": 0,
"job_progress": 0,
"external_id": "string",
"prepayment_ids": [0
],
"id": 0
}
]
}

Invoice Notes Relation Api

API documentation for Invoice Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

invoice required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

invoice required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

invoice required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

invoice required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr invoice

Authorizations:

BearerAuth

path Parameters

invoice required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Invoice Scope Progress Relation Api

API documentation for Invoice Scope Progress Relation Api

Create contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

invoice_id	integer
scope_of_work_id	integer
scope_progress	integer

Responses

Request samples

Payload

Content type

application/json

{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0
}

Response samples

201

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Get a list of contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice required	integer
scopes_progress required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Update contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice required	integer
scopes_progress required	integer

Request Body schema: application/json

invoice_id	integer
scope_of_work_id	integer
scope_progress	integer

Responses

Request samples

Payload

Content type

application/json

{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0
}

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Delete contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice required	integer
scopes_progress required	integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Restore contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice required	integer
scopes_progress required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Create a batch of contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

Array of objects (InvoiceScopeProgress)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0
}
]
}

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
]
}

Update a batch of contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0
}
}
}

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
]
}

Delete a batch of contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

force	boolean
include	string Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
]
}

Restore a batch of contr invoice scope progress

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
]
}

Associate contr invoice scope progress with contr invoice

Authorizations:

BearerAuth

path Parameters

invoice

required

integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Dissociate contr invoice scope progress from contr invoice

Authorizations:

BearerAuth

path Parameters

invoice required	integer
scopes_progress required	integer

query Parameters

include

string

Value: "scopeOfWork"

Responses

Response samples

200

Content type

application/json

{"data": {"invoice_id": 0,
"scope_of_work_id": 0,
"scope_progress": 0,
"id": 0
}
}

Change Order Webhook Api

API documentation for Change Order Webhook Api

Create webhook

Authorizations:

BearerAuth

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

201

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Get a list of webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for webhooks

Authorizations:

BearerAuth

query Parameters

page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "id",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "event",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Update webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Request Body schema: application/json

url	string
event	any Enum: "created" "updated" "deleted" "restored" "saved" "all"
	Array of Array of arrays or strings or null Default: null
columns_changed	Array of strings or null Default: null
description	string or null
active	integer

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0
}

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete webhook

Authorizations:

BearerAuth

path Parameters

webhook

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"url": "string",
"event": "created",
"payload": null,
"columns_changed": null,
"description": "string",
"active": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Change Order Api

API documentation for Change Order Api

Create contr change order

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Request Body schema: application/json

co_number	string
gc_co_number	string or null
title	string
type	integer
project_id	integer
estimator_id	integer or null
description	string or null
date	string <date>
status	any Enum: "draft" "verified" "sent" "disapproved" "approved" "completed"
approved_date	string or null <date>
billed_in_full	integer
billed_in_full_date	string or null <date>
markup_ratio	any
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
co_amount	any
co_amount_currency	string or null
contract_days_added	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Get a list of contr change orders

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr change orders

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "disapproved",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "co_number",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "co_number",
"operator": "<",
"value": "string"
}
]
}
],
"sort": [{"field": "co_number",
"direction": "asc"
}
],
"includes": [{"relation": "materials"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Update contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

co_number	string
gc_co_number	string or null
title	string
type	integer
project_id	integer
estimator_id	integer or null
description	string or null
date	string <date>
status	any Enum: "draft" "verified" "sent" "disapproved" "approved" "completed"
approved_date	string or null <date>
billed_in_full	integer
billed_in_full_date	string or null <date>
markup_ratio	any
misc_est_cost	any
misc_est_cost_currency	string or null
misc_est_mandays	any
co_amount	any
co_amount_currency	string or null
contract_days_added	integer
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Delete contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

force	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Restore contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Responses

Response samples

200

Content type

application/json

{"data": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of contr change orders

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Request Body schema: application/json

Array of objects (ChangeOrder)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr change orders

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr change orders

Authorizations:

BearerAuth

query Parameters

force	boolean
include	string Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr change orders

Authorizations:

BearerAuth

query Parameters

include

string

Enum: "materials" "materials.inventory" "scopesOfWork" "scopesOfWork.stage" "estimator"

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"co_number": "string",
"gc_co_number": "string",
"title": "string",
"type": 0,
"project_id": 0,
"estimator_id": 0,
"description": "string",
"date": "2019-08-24",
"status": "draft",
"approved_date": "2019-08-24",
"billed_in_full": 0,
"billed_in_full_date": "2019-08-24",
"markup_ratio": null,
"misc_est_cost": null,
"misc_est_cost_currency": "string",
"misc_est_mandays": null,
"co_amount": null,
"co_amount_currency": "string",
"contract_days_added": 0,
"external_id": "string",
"id": 0
}
]
}

Change Order Notes Relation Api

API documentation for Change Order Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

change_order required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

change_order required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

change_order required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

change_order required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr change order

Authorizations:

BearerAuth

path Parameters

change_order required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Change Order Materials Relation Api

API documentation for Change Order Materials Relation Api

Create contr change order material

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

contr_co_id	integer
from_inventory	integer
inventory_id	integer or null
description	string or null
quantity	any
unit	string
unit_price	any
unit_price_currency	string
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Get a list of contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr change order material

Authorizations:

BearerAuth

path Parameters

change_order required	integer
material required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Update contr change order material

Authorizations:

BearerAuth

path Parameters

change_order required	integer
material required	integer

Request Body schema: application/json

contr_co_id	integer
from_inventory	integer
inventory_id	integer or null
description	string or null
quantity	any
unit	string
unit_price	any
unit_price_currency	string
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Delete contr change order material

Authorizations:

BearerAuth

path Parameters

change_order required	integer
material required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Restore contr change order material

Authorizations:

BearerAuth

path Parameters

change_order required	integer
material required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Create a batch of contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

Array of objects (ChangeOrderMaterial)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr change order materials

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
]
}

Associate contr change order material with contr change order

Authorizations:

BearerAuth

path Parameters

change_order

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Dissociate contr change order material from contr change order

Authorizations:

BearerAuth

path Parameters

change_order required	integer
material required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"contr_co_id": 0,
"from_inventory": 0,
"inventory_id": 0,
"description": "string",
"quantity": null,
"unit": "string",
"unit_price": null,
"unit_price_currency": "string",
"external_id": "string",
"id": 0
}
}

Subcontractors Agreement Api

API documentation for Subcontractors Agreement Api

Create contr subcontractors agreement

Authorizations:

BearerAuth

Request Body schema: application/json

project_id	integer
company_id	integer
subject	string or null
tm	integer
contract_amount	any
contract_amount_currency	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
paid_in_full	integer or null
completed	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
}

Get a list of contr subcontractors agreements

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr subcontractors agreements

Authorizations:

BearerAuth

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Request Body schema: application/json

	Array of objects
	Array of objects
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"scopes": [{"name": "active",
"parameters": ["string"
]
}
],
"filters": [{"type": "and",
"field": "project_id",
"operator": "<",
"value": "string",
"nested": [{"type": "and",
"field": "project_id",
"operator": "<",
"value": "string"
}
]
}
],
"search": {"value": "string",
"case_sensitive": true
},
"sort": [{"field": "subject",
"direction": "asc"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
}

Update contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

project_id	integer
company_id	integer
subject	string or null
tm	integer
contract_amount	any
contract_amount_currency	string or null
default_hour_rate	any
default_hour_rate_currency	string or null
salary_custom_percentages	integer
salary_secondary_percentage	any
overtime_primary_percentage	any
overtime_secondary_percentage	any
paid_in_full	integer or null
completed	integer or null
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
}

Delete contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
}

Restore contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
}

Create a batch of contr subcontractors agreements

Authorizations:

BearerAuth

Request Body schema: application/json

Array of objects (SubcontractorsAgreement)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
]
}

Update a batch of contr subcontractors agreements

Authorizations:

BearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of contr subcontractors agreements

Authorizations:

BearerAuth

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of contr subcontractors agreements

Authorizations:

BearerAuth

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"project_id": 0,
"company_id": 0,
"subject": "string",
"tm": 0,
"contract_amount": null,
"contract_amount_currency": "string",
"default_hour_rate": null,
"default_hour_rate_currency": "string",
"salary_custom_percentages": 0,
"salary_secondary_percentage": null,
"overtime_primary_percentage": null,
"overtime_secondary_percentage": null,
"paid_in_full": 0,
"completed": 0,
"external_id": "string",
"id": 0
}
]
}

Subcontractors Agreement Notes Relation Api

API documentation for Subcontractors Agreement Notes Relation Api

Create note

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

201

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Get a list of notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get note

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
note required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Update note

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
note required	integer

Request Body schema: application/json

title	string
note	any
files	Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.
permission	integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private
sticky	integer
category_id	integer or null
alert	integer
alert_grid	integer
alert_to	string or null <date>
alert_type	any
external_id	string or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Delete note

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
note required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Restore note

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Create a batch of notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

Array of objects (Note)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Update a batch of notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Delete a batch of notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Restore a batch of notes

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
]
}

Associate note with contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Dissociate note from contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
note required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"title": "string",
"note": null,
"files": ["string"
],
"permission": 1,
"sticky": 0,
"category_id": 0,
"alert": 0,
"alert_grid": 0,
"alert_to": "2019-08-24",
"alert_type": null,
"external_id": "string",
"id": 0
}
}

Subcontractors Paid Relation Api

API documentation for Subcontractors Paid Relation Api

Create contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

agreement_id	integer
date	string <date>
amount	any
amount_currency	string
description	string or null

Responses

Request samples

Payload

Content type

application/json

{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Get a list of contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Search for contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

with_trashed	boolean
only_trashed	boolean
page	integer Default: 1
limit	integer Default: 20

Responses

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
paid required	integer

query Parameters

with_trashed	boolean
only_trashed	boolean

Responses

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Update contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
paid required	integer

Request Body schema: application/json

agreement_id	integer
date	string <date>
amount	any
amount_currency	string
description	string or null

Responses

Request samples

Payload

Content type

application/json

{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Delete contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
paid required	integer

query Parameters

force

boolean

Responses

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Restore contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
paid required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Create a batch of contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

Array of objects (SubcontractorsPaid)

Responses

Request samples

Payload

Content type

application/json

{"resources": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string"
}
]
}

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
]
}

Update a batch of contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"resources": {"{key}": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string"
}
}
}

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
]
}

Delete a batch of contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

query Parameters

force

boolean

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
]
}

Restore a batch of contr subcontractors paid

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Request Body schema: application/json

resources

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"resources": [0
]
}

Response samples

200

Content type

application/json

{"data": [{"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
]
}

Associate contr subcontractors paid with contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement

required

integer

Responses

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Dissociate contr subcontractors paid from contr subcontractors agreement

Authorizations:

BearerAuth

path Parameters

subcontractors_agreement required	integer
paid required	integer

Responses

Response samples

200

Content type

application/json

{"data": {"agreement_id": 0,
"date": "2019-08-24",
"amount": null,
"amount_currency": "string",
"description": "string",
"id": 0
}
}

Auth Api

Login to obtain bearer token

Request Body schema: application/json

username required	string
password required	string
api_token	string API token for 2FA-enabled accounts
useragent	string Client identifier for auditing

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"api_token": "string",
"useragent": "string"
}

Response samples

200

Content type

application/json

{"access_token": "string",
"token_type": "Bearer",
"expires_in": 0
}

Get authenticated user info

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"status": "success",
"username": "string",
"name": "string",
"email": "user@example.com",
"avatar": "http://example.com",
"contact": {"id": 0,
"first_name": "string",
"last_name": "string",
"phone": "string",
"mobile": "string",
"email": "user@example.com"
}
}