API docs by Redocly

Contractors.es API Docs (1.0.4)

Download OpenAPI specification:

Sample code:

Country Api

API documentation for Country Api

Get a list of countries

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{}

Search for countries

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get country

Authorizations:
BearerAuthOAuth2
path Parameters
country
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

State Api

API documentation for State Api

Get a list of states

Authorizations:
BearerAuthOAuth2
path Parameters
country
required
integer

Responses

Response samples

Content type
application/json
{}

Search for states

Authorizations:
BearerAuthOAuth2
path Parameters
country
required
integer
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get state

Authorizations:
BearerAuthOAuth2
path Parameters
country
required
integer
state
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Associate state with country

Authorizations:
BearerAuthOAuth2
path Parameters
country
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Companies Webhook Api

API documentation for Companies Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Company Api

API documentation for Company Api

Create company

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of companies

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for companies

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get company

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete company

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore company

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of companies

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Company)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of companies

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of companies

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of companies

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Company Group Api

API documentation for Company Group Api

Create company group

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of company groups

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for company groups

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get company group

Authorizations:
BearerAuthOAuth2
path Parameters
company_group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company group

Authorizations:
BearerAuthOAuth2
path Parameters
company_group
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete company group

Authorizations:
BearerAuthOAuth2
path Parameters
company_group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore company group

Authorizations:
BearerAuthOAuth2
path Parameters
company_group
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of company groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (CompanyGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of company groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of company groups

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of company groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Company Group Relation Api

API documentation for Company Group Relation Api

Create company group

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Get company group

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company group

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
group
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete company group

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
Array of objects (CompanyGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle company groups

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Update pivot

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
group
required
integer
Request Body schema: application/json
pivot
object

Pivot fields

Responses

Request samples

Content type
application/json
{
  • "pivot": { }
}

Response samples

Content type
application/json
{
  • "updated": [
    ]
}

Company Sales Representative Relation Api

API documentation for Company Sales Representative Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
salesRepresentative
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Contact Webhook Api

API documentation for Contact Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Contact Api

API documentation for Contact Api

Create contact

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contacts

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contact

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contact

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contacts

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Contact)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contacts

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contacts

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contacts

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Contact Group Api

API documentation for Contact Group Api

Create contact group

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contact groups

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for contact groups

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact_group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact_group
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact_group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact_group
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contact groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (ContactGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contact groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contact groups

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contact groups

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Contact Group Relation Api

API documentation for Contact Group Relation Api

Create contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Get contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
group
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact group

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
Array of objects (ContactGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contact groups

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Update pivot

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
group
required
integer
Request Body schema: application/json
pivot
object

Pivot fields

Responses

Request samples

Content type
application/json
{
  • "pivot": { }
}

Response samples

Content type
application/json
{
  • "updated": [
    ]
}

Contact Sales Representative Relation Api

API documentation for Contact Sales Representative Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
salesRepresentative
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Webhook Api

API documentation for Meeting Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Meeting Api

API documentation for Meeting Api

Create meeting

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
title
string
start
string
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

Content type
application/json
{
  • "title": "string",
  • "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

Content type
application/json
{
  • "data": {
    }
}

Get a list of meetings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for meetings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get meeting

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update meeting

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
title
string
start
string
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

Content type
application/json
{
  • "title": "string",
  • "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

Content type
application/json
{
  • "data": {
    }
}

Delete meeting

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore meeting

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of meetings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Meeting)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of meetings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of meetings

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of meetings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Meeting Customer Relation Api

API documentation for Meeting Customer Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
customer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Employee Relation Api

API documentation for Meeting Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Location Api

API documentation for Meeting Location Api

Create meeting location

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
name
string
active
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of meeting locations

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for meeting locations

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get meeting location

Authorizations:
BearerAuthOAuth2
path Parameters
meeting_location
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update meeting location

Authorizations:
BearerAuthOAuth2
path Parameters
meeting_location
required
integer
Request Body schema: application/json
name
string
active
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete meeting location

Authorizations:
BearerAuthOAuth2
path Parameters
meeting_location
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore meeting location

Authorizations:
BearerAuthOAuth2
path Parameters
meeting_location
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of meeting locations

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (MeetingLocation)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of meeting locations

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of meeting locations

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of meeting locations

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Task Webhook Api

API documentation for Task Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Task Api

API documentation for Task Api

Create task

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
title
string
status
integer
priority
integer
deadline_date
string or null <date>
deadline_time
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

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "priority": 0,
  • "deadline_date": "2019-08-24",
  • "deadline_time": "string",
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of tasks

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for tasks

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get task

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update task

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
title
string
status
integer
priority
integer
deadline_date
string or null <date>
deadline_time
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

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "priority": 0,
  • "deadline_date": "2019-08-24",
  • "deadline_time": "string",
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete task

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore task

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of tasks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Task)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of tasks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of tasks

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of tasks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Task Customer Relation Api

API documentation for Task Customer Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
customer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Task Employee Relation Api

API documentation for Task Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Phone Call Webhook Api

API documentation for Phone Call Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Phone Call Api

API documentation for Phone Call Api

Create phone call

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
subject
string
date
string <date>
time
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

Content type
application/json
{
  • "subject": "string",
  • "date": "2019-08-24",
  • "time": "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

Content type
application/json
{
  • "data": {
    }
}

Get a list of phone calls

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for phone calls

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get phone call

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update phone call

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
Request Body schema: application/json
subject
string
date
string <date>
time
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

Content type
application/json
{
  • "subject": "string",
  • "date": "2019-08-24",
  • "time": "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

Content type
application/json
{
  • "data": {
    }
}

Delete phone call

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore phone call

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of phone calls

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (PhoneCall)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of phone calls

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of phone calls

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of phone calls

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Phone Call Employee Relation Api

API documentation for Phone Call Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Warehouse Api

API documentation for Warehouse Api

Create assets warehouse

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets warehouses

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets warehouses

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets warehouse

Authorizations:
BearerAuthOAuth2
path Parameters
warehouse
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets warehouse

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets warehouse

Authorizations:
BearerAuthOAuth2
path Parameters
warehouse
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets warehouse

Authorizations:
BearerAuthOAuth2
path Parameters
warehouse
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets warehouses

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Warehouse)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets warehouses

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets warehouses

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets warehouses

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Api

API documentation for Inventory Api

Create assets inventory

Authorizations:
BearerAuthOAuth2
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

Responses

Request samples

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"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory

Authorizations:
BearerAuthOAuth2
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

Responses

Request samples

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"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Inventory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Storage Relation Api

API documentation for Inventory Storage Relation Api

Create assets inventory storage

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "inventory_id": 0,
  • "type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
storage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory storage

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "inventory_id": 0,
  • "type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
storage
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
storage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
Array of objects (InventoryStorage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory storage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory storage with assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory storage from assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
storage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Usage Relation Api

API documentation for Inventory Usage Relation Api

Create assets inventory usage

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory usage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
usage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory usage

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory usage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
usage
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory usage

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
usage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
Array of objects (InventoryUsage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory usages

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory usage with assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory usage from assets inventory

Authorizations:
BearerAuthOAuth2
path Parameters
inventory
required
integer
usage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Category Api

API documentation for Inventory Category Api

Create assets inventory category

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
name
string
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory categories

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for assets inventory categories

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get assets inventory category

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_category
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory category

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_category
required
integer
Request Body schema: application/json
name
string
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory category

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_category
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory category

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_category
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (InventoryCategory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory categories

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Purchase Api

API documentation for Inventory Purchase Api

Create assets inventory purchase

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory purchases

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory purchases

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory purchase

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory purchase

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory purchase

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory purchase

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory purchases

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (InventoryPurchase)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory purchases

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory purchases

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory purchases

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Purchase Row Relation Api

API documentation for Inventory Purchase Row Relation Api

Create assets inventory purchase row

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory purchase row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
row
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory purchase row

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory purchase row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
row
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory purchase row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
Array of objects (InventoryPurchaseRow)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory purchase rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory purchase row with assets inventory purchase

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory purchase row from assets inventory purchase

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_purchase
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Transfer Api

API documentation for Inventory Transfer Api

Create assets inventory transfer

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory transfers

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory transfers

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory transfer

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory transfer

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory transfer

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory transfer

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory transfers

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (InventoryTransfer)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory transfers

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory transfers

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory transfers

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Transfer Row Relation Api

API documentation for Inventory Transfer Row Relation Api

Create assets inventory transfer row

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "transfer_id": 0,
  • "inventory_id": 0,
  • "from_id": 0,
  • "to_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Get assets inventory transfer row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
row
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory transfer row

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "transfer_id": 0,
  • "inventory_id": 0,
  • "from_id": 0,
  • "to_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory transfer row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
row
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory transfer row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
Request Body schema: application/json
Array of objects (InventoryTransferRow)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory transfer rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory transfer row with assets inventory transfer

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory transfer row from assets inventory transfer

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_transfer
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Stocktaking Api

API documentation for Inventory Stocktaking Api

Create assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "memo": "string",
  • "status": "canceled",
  • "storage_type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "memo": "string",
  • "status": "canceled",
  • "storage_type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (InventoryStocktaking)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory stocktakings

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Stocktaking Row Relation Api

API documentation for Inventory Stocktaking Row Relation Api

Create assets inventory stocktaking row

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "stocktaking_id": 0,
  • "inventory_id": 0,
  • "storage_id": 0,
  • "quantity_before": null,
  • "quantity_after": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory stocktaking row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
row
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory stocktaking row

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "stocktaking_id": 0,
  • "inventory_id": 0,
  • "storage_id": 0,
  • "quantity_before": null,
  • "quantity_after": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory stocktaking row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
row
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory stocktaking row

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
Request Body schema: application/json
Array of objects (InventoryStocktakingRow)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory stocktaking rows

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory stocktaking row with assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory stocktaking row from assets inventory stocktaking

Authorizations:
BearerAuthOAuth2
path Parameters
inventory_stocktaking
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Equipment Api

API documentation for Equipment Api

Create assets equipment

Authorizations:
BearerAuthOAuth2
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>
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

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",
  • "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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets equipment

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets equipment

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets equipment

Authorizations:
BearerAuthOAuth2
path Parameters
equipment
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets equipment

Authorizations:
BearerAuthOAuth2
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>
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

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",
  • "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

Content type
application/json
{
  • "data": {
    }
}

Delete assets equipment

Authorizations:
BearerAuthOAuth2
path Parameters
equipment
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets equipment

Authorizations:
BearerAuthOAuth2
path Parameters
equipment
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets equipment

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (Equipment)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets equipment

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets equipment

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets equipment

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Equipment Category Api

API documentation for Equipment Category Api

Create assets equipment category

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "name": "string",
  • "cost_per_unit": null,
  • "cost_per_unit_currency": "string",
  • "unit": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets equipment categories

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets equipment categories

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets equipment category

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_category
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets equipment category

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "name": "string",
  • "cost_per_unit": null,
  • "cost_per_unit_currency": "string",
  • "unit": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets equipment category

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_category
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets equipment category

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_category
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets equipment categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (EquipmentCategory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets equipment categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets equipment categories

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets equipment categories

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Equipment History Api

API documentation for Equipment History Api

Create assets equipment history

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets equipment history

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for assets equipment history

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets equipment history

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_history
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets equipment history

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete assets equipment history

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_history
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets equipment history

Authorizations:
BearerAuthOAuth2
path Parameters
equipment_history
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets equipment history

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (EquipmentHistory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets equipment history

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets equipment history

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets equipment history

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Scope Of Work Api

API documentation for Scope Of Work Api

Get a list of contr scope of works

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr scope of works

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
scope_of_work
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Webhook Api

API documentation for Project Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Api

API documentation for Project Api

Create contr project

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts"
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

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": [
    ],
  • "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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts"
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Enum: "company" "contacts"
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

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": [
    ],
  • "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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
force
boolean
include
string
Enum: "company" "contacts"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Enum: "company" "contacts"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts"
Request Body schema: application/json
Array of objects (Project)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Enum: "company" "contacts"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr projects

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Project Contacts Relation Api

API documentation for Project Contacts Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Architects Relation Api

API documentation for Project Architects Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
architect
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Engineers Relation Api

API documentation for Project Engineers Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
engineer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Project Managers Relation Api

API documentation for Project Project Managers Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
project_manager
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Estimators Relation Api

API documentation for Project Estimators Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
estimator
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Roadmen Relation Api

API documentation for Project Roadmen Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
roadman
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Foremen Relation Api

API documentation for Project Foremen Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
foreman
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Building Inspectors Relation Api

API documentation for Project Building Inspectors Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
building_inspector
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Gc Estimators Relation Api

API documentation for Project Gc Estimators Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
gc_estimator
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Gc Project Managers Relation Api

API documentation for Project Gc Project Managers Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
gc_project_manager
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Gc Superintendents Relation Api

API documentation for Project Gc Superintendents Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
gc_superintendent
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Scopes Of Work Relation Api

API documentation for Project Scopes Of Work Relation Api

Create contr project scope of work

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project scope of work

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "data": {
    }
}

Update contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
scopes_of_work
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
scopes_of_work
required
integer
query Parameters
force
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
scopes_of_work
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
Array of objects (ProjectScopeOfWork)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project scope of work with contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project scope of work from contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
scopes_of_work
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Change Orders Relation Api

API documentation for Project Change Orders Relation Api

Create contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
co_number
string
gc_co_number
string or null
title
string
type
integer
project_id
integer
project_stage_id
integer or null
estimator_id
integer or null
scope_of_work_id
integer
description
string or null
date
string <date>
status
any
approved_date
string or null <date>
billed
integer
billed_date
string or null <date>
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
markup_ratio
any
co_amount
any
co_amount_currency
string or null
contract_days_added
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "co_number": "string",
  • "gc_co_number": "string",
  • "title": "string",
  • "type": 0,
  • "project_id": 0,
  • "project_stage_id": 0,
  • "estimator_id": 0,
  • "scope_of_work_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "status": null,
  • "approved_date": "2019-08-24",
  • "billed": 0,
  • "billed_date": "2019-08-24",
  • "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",
  • "markup_ratio": null,
  • "co_amount": null,
  • "co_amount_currency": "string",
  • "contract_days_added": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr change orders

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr change orders

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
change_order
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
change_order
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
co_number
string
gc_co_number
string or null
title
string
type
integer
project_id
integer
project_stage_id
integer or null
estimator_id
integer or null
scope_of_work_id
integer
description
string or null
date
string <date>
status
any
approved_date
string or null <date>
billed
integer
billed_date
string or null <date>
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
markup_ratio
any
co_amount
any
co_amount_currency
string or null
contract_days_added
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "co_number": "string",
  • "gc_co_number": "string",
  • "title": "string",
  • "type": 0,
  • "project_id": 0,
  • "project_stage_id": 0,
  • "estimator_id": 0,
  • "scope_of_work_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "status": null,
  • "approved_date": "2019-08-24",
  • "billed": 0,
  • "billed_date": "2019-08-24",
  • "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",
  • "markup_ratio": null,
  • "co_amount": null,
  • "co_amount_currency": "string",
  • "contract_days_added": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
change_order
required
integer
query Parameters
force
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
change_order
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr change orders

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
Array of objects (ChangeOrder)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr change orders

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr change orders

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr change orders

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr change order with contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr change order from contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
change_order
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Stage Webhook Api

API documentation for Project Stage Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Stage Api

API documentation for Project Stage Api

Create contr project stage

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
project_id
integer
stage_number
integer
name
string
status
any
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

Content type
application/json
{
  • "project_id": 0,
  • "stage_number": 0,
  • "name": "string",
  • "status": null,
  • "prepayment_percentage": null,
  • "prepayment_received_date": "2019-08-24",
  • "stage_amount": null,
  • "stage_amount_currency": "string",
  • "acceptation_notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"
Request Body schema: application/json
Array of objects
object
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "search": {
    },
  • "sort": [
    ],
  • "includes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
project_id
integer
stage_number
integer
name
string
status
any
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

Content type
application/json
{
  • "project_id": 0,
  • "stage_number": 0,
  • "name": "string",
  • "status": null,
  • "prepayment_percentage": null,
  • "prepayment_received_date": "2019-08-24",
  • "stage_amount": null,
  • "stage_amount_currency": "string",
  • "acceptation_notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
force
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
Array of objects (ProjectStage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Value: "scopesOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project stages

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Project Stages Relation Api

API documentation for Project Stages Relation Api

Create contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
project_id
integer
stage_number
integer
name
string
status
any
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

Content type
application/json
{
  • "project_id": 0,
  • "stage_number": 0,
  • "name": "string",
  • "status": null,
  • "prepayment_percentage": null,
  • "prepayment_received_date": "2019-08-24",
  • "stage_amount": null,
  • "stage_amount_currency": "string",
  • "acceptation_notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project stages

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project stages

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"
Request Body schema: application/json
Array of objects
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "search": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
stage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
stage
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
project_id
integer
stage_number
integer
name
string
status
any
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

Content type
application/json
{
  • "project_id": 0,
  • "stage_number": 0,
  • "name": "string",
  • "status": null,
  • "prepayment_percentage": null,
  • "prepayment_received_date": "2019-08-24",
  • "stage_amount": null,
  • "stage_amount_currency": "string",
  • "acceptation_notes": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
stage
required
integer
query Parameters
force
boolean
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
stage
required
integer
query Parameters
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project stages

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
Array of objects (ProjectStage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project stages

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project stages

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project stages

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopesOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project stage with contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
query Parameters
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project stage from contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project
required
integer
stage
required
integer
query Parameters
include
string
Value: "scopesOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Stage Scopes Of Work Relation Api

API documentation for Project Stage Scopes Of Work Relation Api

Create contr project scope of work

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
scopes_of_work
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project scope of work

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
scopes_of_work
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
scopes_of_work
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
Request Body schema: application/json
Array of objects (ProjectScopeOfWork)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project scope of work with contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project scope of work from contr project stage

Authorizations:
BearerAuthOAuth2
path Parameters
project_stage
required
integer
scopes_of_work
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Bidding Webhook Api

API documentation for Project Bidding Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Bidding Api

API documentation for Project Bidding Api

Create contr project bidding

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts" "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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"
Request Body schema: application/json
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ],
  • "includes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
include
string
Enum: "company" "contacts" "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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
force
boolean
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"
Request Body schema: application/json
Array of objects (ProjectBidding)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project biddings

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "company" "contacts" "proposals" "filledProposals" "projects"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Project Bidding Contacts Relation Api

API documentation for Project Bidding Contacts Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Bidding Estimators Relation Api

API documentation for Project Bidding Estimators Relation Api

Get a list of contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
estimator
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Project Bidding Proposals Relation Api

API documentation for Project Bidding Proposals Relation Api

Create contr project proposal

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
proposal
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project proposal

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
proposal
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
proposal
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
Array of objects (ProjectProposal)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project proposal with contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project proposal from contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
proposal
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Bidding Filled Proposals Relation Api

API documentation for Project Bidding Filled Proposals Relation Api

Create contr project proposal

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
filled_proposal
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project proposal

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
filled_proposal
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
filled_proposal
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
Array of objects (ProjectProposal)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project proposal with contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project proposal from contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
filled_proposal
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Bidding Projects Relation Api

API documentation for Project Bidding Projects Relation Api

Create contr project

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
project
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr project

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
project
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
project
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
Array of objects (Project)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr projects

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project with contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project from contr project bidding

Authorizations:
BearerAuthOAuth2
path Parameters
project_bidding
required
integer
project
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Proposal Webhook Api

API documentation for Project Proposal Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Project Proposal Api

API documentation for Project Proposal Api

Create contr project proposal

Authorizations:
BearerAuthOAuth2
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
Request Body schema: application/json
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ],
  • "includes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project proposal

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "data": {
    }
}

Update contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
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

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": [
    ],
  • "awarded": 0,
  • "award_date": "2019-08-24",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
force
boolean
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
Request Body schema: application/json
Array of objects (ProjectProposal)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project proposals

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "projectBidding" "scopesOfWork" "materials" "project" "fields"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

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:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr project proposal scope of work

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "data": {
    }
}

Update contr project proposal scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
scopes_of_work
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr project proposal scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
scopes_of_work
required
integer
query Parameters
force
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr project proposal scope of work

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
scopes_of_work
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
Array of objects (ProjectProposalScopeOfWork)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr project proposal scope of works

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr project proposal scope of work with contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr project proposal scope of work from contr project proposal

Authorizations:
BearerAuthOAuth2
path Parameters
project_proposal
required
integer
scopes_of_work
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Invoice Webhook Api

API documentation for Invoice Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Invoice Api

API documentation for Invoice Api

Create contr invoice

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
project_id
integer
project_stage_id
integer or null
change_order_id
integer or null
type
any
Enum: "partial" "prepayment"
invoice_no
string
date
string <date>
due_date
string <date>
description
string
footer
any
Array of objects
amount
any
amount_currency
string
paid_amount
any
document_paid_amount
any
document_paid_amount_currency
string
paid_amount_currency
string
paid_in_full
integer
update_progress
integer
job_progress
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "project_id": 0,
  • "project_stage_id": 0,
  • "change_order_id": 0,
  • "type": "partial",
  • "invoice_no": "string",
  • "date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "description": "string",
  • "footer": null,
  • "tax_rates": [
    ],
  • "amount": null,
  • "amount_currency": "string",
  • "paid_amount": null,
  • "document_paid_amount": null,
  • "document_paid_amount_currency": "string",
  • "paid_amount_currency": "string",
  • "paid_in_full": 0,
  • "update_progress": 0,
  • "job_progress": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "project" "projectStage" "changeOrder"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "project" "projectStage" "changeOrder"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
project_id
integer
project_stage_id
integer or null
change_order_id
integer or null
type
any
Enum: "partial" "prepayment"
invoice_no
string
date
string <date>
due_date
string <date>
description
string
footer
any
Array of objects
amount
any
amount_currency
string
paid_amount
any
document_paid_amount
any
document_paid_amount_currency
string
paid_amount_currency
string
paid_in_full
integer
update_progress
integer
job_progress
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "project_id": 0,
  • "project_stage_id": 0,
  • "change_order_id": 0,
  • "type": "partial",
  • "invoice_no": "string",
  • "date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "description": "string",
  • "footer": null,
  • "tax_rates": [
    ],
  • "amount": null,
  • "amount_currency": "string",
  • "paid_amount": null,
  • "document_paid_amount": null,
  • "document_paid_amount_currency": "string",
  • "paid_amount_currency": "string",
  • "paid_in_full": 0,
  • "update_progress": 0,
  • "job_progress": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
force
boolean
include
string
Enum: "project" "projectStage" "changeOrder"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
Array of objects (Invoice)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr invoices

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "project" "projectStage" "changeOrder"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Invoice Scope Progress Relation Api

API documentation for Invoice Scope Progress Relation Api

Create contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "invoice_id": 0,
  • "scope_of_work_id": 0,
  • "scope_progress": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{}

Search for contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{}

Get contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
scopes_progress
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
scopes_progress
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

Content type
application/json
{
  • "invoice_id": 0,
  • "scope_of_work_id": 0,
  • "scope_progress": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
scopes_progress
required
integer
query Parameters
force
boolean
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
scopes_progress
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
Array of objects (InvoiceScopeProgress)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr invoice scopes progress

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Value: "scopeOfWork"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr invoice scopes progress with contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr invoice scopes progress from contr invoice

Authorizations:
BearerAuthOAuth2
path Parameters
invoice
required
integer
scopes_progress
required
integer
query Parameters
include
string
Value: "scopeOfWork"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Change Order Webhook Api

API documentation for Change Order Webhook Api

Create webhook

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuthOAuth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for webhooks

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
payload
any
columns_changed
any
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuthOAuth2
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Change Order Api

API documentation for Change Order Api

Create contr change order

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
co_number
string
gc_co_number
string or null
title
string
type
integer
project_id
integer
project_stage_id
integer or null
estimator_id
integer or null
scope_of_work_id
integer
description
string or null
date
string <date>
status
any
approved_date
string or null <date>
billed
integer
billed_date
string or null <date>
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
markup_ratio
any
co_amount
any
co_amount_currency
string or null
contract_days_added
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "co_number": "string",
  • "gc_co_number": "string",
  • "title": "string",
  • "type": 0,
  • "project_id": 0,
  • "project_stage_id": 0,
  • "estimator_id": 0,
  • "scope_of_work_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "status": null,
  • "approved_date": "2019-08-24",
  • "billed": 0,
  • "billed_date": "2019-08-24",
  • "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",
  • "markup_ratio": null,
  • "co_amount": null,
  • "co_amount_currency": "string",
  • "contract_days_added": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ],
  • "includes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
co_number
string
gc_co_number
string or null
title
string
type
integer
project_id
integer
project_stage_id
integer or null
estimator_id
integer or null
scope_of_work_id
integer
description
string or null
date
string <date>
status
any
approved_date
string or null <date>
billed
integer
billed_date
string or null <date>
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
markup_ratio
any
co_amount
any
co_amount_currency
string or null
contract_days_added
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "co_number": "string",
  • "gc_co_number": "string",
  • "title": "string",
  • "type": 0,
  • "project_id": 0,
  • "project_stage_id": 0,
  • "estimator_id": 0,
  • "scope_of_work_id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "status": null,
  • "approved_date": "2019-08-24",
  • "billed": 0,
  • "billed_date": "2019-08-24",
  • "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",
  • "markup_ratio": null,
  • "co_amount": null,
  • "co_amount_currency": "string",
  • "contract_days_added": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
force
boolean
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
Array of objects (ChangeOrder)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr change orders

Authorizations:
BearerAuthOAuth2
query Parameters
include
string
Enum: "scopeOfWork" "materials" "materials.inventory" "projectStage" "scopeOfWork" "estimator" "invoices"
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Change Order Materials Relation Api

API documentation for Change Order Materials Relation Api

Create contr change order material

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr change order material

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
material
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr change order material

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr change order material

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
material
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr change order material

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
material
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
Request Body schema: application/json
Array of objects (ChangeOrderMaterial)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr change order materials

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr change order material with contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr change order material from contr change order

Authorizations:
BearerAuthOAuth2
path Parameters
change_order
required
integer
material
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Subcontractors Agreement Api

API documentation for Subcontractors Agreement Api

Create contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Search for contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
query Parameters
with_trashed
boolean
only_trashed
boolean
Request Body schema: application/json
Array of objects
Array of objects
object

Responses

Request samples

Content type
application/json
{
  • "scopes": [
    ],
  • "filters": [
    ],
  • "search": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
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

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

Content type
application/json
{
  • "data": {
    }
}

Delete contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
Array of objects (SubcontractorsAgreement)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr subcontractors agreements

Authorizations:
BearerAuthOAuth2
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Subcontractors Paid Relation Api

API documentation for Subcontractors Paid Relation Api

Create contr subcontractors paid

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "agreement_id": 0,
  • "date": "2019-08-24",
  • "amount": null,
  • "amount_currency": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Search for contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{}

Get contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
paid
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contr subcontractors paid

Authorizations:
BearerAuthOAuth2
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

Content type
application/json
{
  • "agreement_id": 0,
  • "date": "2019-08-24",
  • "amount": null,
  • "amount_currency": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
paid
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
paid
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
Request Body schema: application/json
Array of objects (SubcontractorsPaid)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contr subcontractors paid

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate contr subcontractors paid with contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate contr subcontractors paid from contr subcontractors agreement

Authorizations:
BearerAuthOAuth2
path Parameters
subcontractors_agreement
required
integer
paid
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}