Download OpenAPI specification:
Sample code:
JavaScript - open test.html in a browser.
NodeJS - Requires installed nodejs/npm.
npm install
npm run test
PHP 8 - Requires installed composer.
composer require contractors-es/api
python test.py
n8n community node Install the community node package in your n8n instance - go to settings, community nodes and add:
@contractors-es/n8n-nodes-contractors-es
Add Contractors.es API credentials in n8n and create a workflow with the Contractors.es node.
All datetimes are handled in UTC. Datetimes returned by the API include time in UTC, and any datetime you pass is treated as UTC. If you provide an ISO-8601 datetime (YYYY-MM-DDTHH:MM+TZ:00), it will be converted to UTC.
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "code": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "code",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "code",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "code",
- "direction": "asc"
}
]
}{- "data": [
- {
- "code": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| country required | integer |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "code": "string",
- "name": "string",
- "country_id": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| country required | integer |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "code",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "code",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "code",
- "direction": "asc"
}
]
}{- "data": [
- {
- "code": "string",
- "name": "string",
- "country_id": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "event",
- "direction": "asc"
}
]
}{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| webhook required | integer |
| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| company_name | string |
| short_name | string or null |
| phone | string or null |
| fax | string or null |
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 |
{- "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"
}{- "data": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "vendors",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "company_name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "company_name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "company_name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| company_name | string |
| short_name | string or null |
| phone | string or null |
| fax | string or null |
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 |
{- "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"
}{- "data": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| force | boolean |
{- "data": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
}{- "data": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
}Array of objects (Company) |
{- "resources": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string"
}
]
}{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string"
}
}
}{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "company_name": "string",
- "short_name": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "web_address": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "tax_id": "string",
- "memo": "string",
- "default_hour_rate": null,
- "default_hour_rate_currency": "string",
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "id": 0
}
]
}| company required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| company required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| company required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| company required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| company required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| company required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| slug | string or null |
| name | string |
{- "slug": "string",
- "name": "string"
}{- "data": {
- "slug": "string",
- "name": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company_group required | integer |
| slug | string or null |
| name | string |
{- "slug": "string",
- "name": "string"
}{- "data": {
- "slug": "string",
- "name": "string",
- "id": 0
}
}Array of objects (CompanyGroup) |
{- "resources": [
- {
- "slug": "string",
- "name": "string"
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "slug": "string",
- "name": "string"
}
}
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| company required | integer |
| slug | string or null |
| name | string |
{- "slug": "string",
- "name": "string"
}{- "data": {
- "slug": "string",
- "name": "string",
- "id": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| group required | integer |
| slug | string or null |
| name | string |
{- "slug": "string",
- "name": "string"
}{- "data": {
- "slug": "string",
- "name": "string",
- "id": 0
}
}| company required | integer |
Array of objects (CompanyGroup) |
{- "resources": [
- {
- "slug": "string",
- "name": "string"
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| company required | integer |
object |
{- "resources": {
- "{key}": {
- "slug": "string",
- "name": "string"
}
}
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| company required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "id": 0
}
]
}| company required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| company required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}API documentation for Company Sales Representative Relation Api
| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| company required | integer |
| salesRepresentative required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| company required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| company required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "event",
- "direction": "asc"
}
]
}{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| webhook required | integer |
| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| 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 |
string or null | |
| send_docs_from_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 |
| has_custom_employer_cost_markup | integer |
| employer_cost_markup_percentage | any |
| 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> |
{- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "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"
}{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "employees",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "first_name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "first_name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "first_name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| contact required | integer |
| 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 |
string or null | |
| send_docs_from_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 |
| has_custom_employer_cost_markup | integer |
| employer_cost_markup_percentage | any |
| 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> |
{- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "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"
}{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| contact required | integer |
| force | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}Array of objects (Contact) |
{- "resources": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "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"
}
]
}{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "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"
}
}
}{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
]
}| contact required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| contact required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| contact required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| contact required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| contact required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| contact required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| slug | string or null |
| name | string |
| filter | integer |
{- "slug": "string",
- "name": "string",
- "filter": 0
}{- "data": {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact_group required | integer |
| slug | string or null |
| name | string |
| filter | integer |
{- "slug": "string",
- "name": "string",
- "filter": 0
}{- "data": {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
}Array of objects (ContactGroup) |
{- "resources": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "slug": "string",
- "name": "string",
- "filter": 0
}
}
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| contact required | integer |
| slug | string or null |
| name | string |
| filter | integer |
{- "slug": "string",
- "name": "string",
- "filter": 0
}{- "data": {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| group required | integer |
| slug | string or null |
| name | string |
| filter | integer |
{- "slug": "string",
- "name": "string",
- "filter": 0
}{- "data": {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
}| contact required | integer |
Array of objects (ContactGroup) |
{- "resources": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0
}
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| contact required | integer |
object |
{- "resources": {
- "{key}": {
- "slug": "string",
- "name": "string",
- "filter": 0
}
}
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| contact required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "slug": "string",
- "name": "string",
- "filter": 0,
- "id": 0
}
]
}| contact required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| contact required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}API documentation for Contact Sales Representative Relation Api
| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| contact required | integer |
| salesRepresentative required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| contact required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| contact required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "event",
- "direction": "asc"
}
]
}{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| webhook required | integer |
| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| title | string |
| schedule_type | string Enum: "date" "datetime" |
| scheduled_date | string or null <date> |
| start | string or null |
| end | string or null |
| priority | integer |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| recurring | integer |
| recurring_type | string or null |
| recurring_interval | integer or null |
| recurring_month | string or null |
| recurring_weekday | any |
| recurring_end | string or null <date> |
| location_id | integer or null |
| external_id | string or null |
{- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "today",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "title",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "title",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "scheduled_date",
- "direction": "asc"
}
]
}{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| title | string |
| schedule_type | string Enum: "date" "datetime" |
| scheduled_date | string or null <date> |
| start | string or null |
| end | string or null |
| priority | integer |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| recurring | integer |
| recurring_type | string or null |
| recurring_interval | integer or null |
| recurring_month | string or null |
| recurring_weekday | any |
| recurring_end | string or null <date> |
| location_id | integer or null |
| external_id | string or null |
{- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
}{- "data": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
}Array of objects (Meeting) |
{- "resources": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "start": "string",
- "end": "string",
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "recurring": 0,
- "recurring_type": "string",
- "recurring_interval": 0,
- "recurring_month": "string",
- "recurring_weekday": null,
- "recurring_end": "2019-08-24",
- "location_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| meeting required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| meeting required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| meeting required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| meeting required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| meeting required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| customer required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| meeting required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| meeting required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting required | integer |
| employee required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| meeting required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| meeting required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| meeting_location required | integer |
| name | string |
| active | integer |
{- "name": "string",
- "active": 0
}{- "data": {
- "name": "string",
- "active": 0,
- "id": 0
}
}Array of objects (MeetingLocation) |
{- "resources": [
- {
- "name": "string",
- "active": 0
}
]
}{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "name": "string",
- "active": 0
}
}
}{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "active": 0,
- "id": 0
}
]
}| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "event",
- "direction": "asc"
}
]
}{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| webhook required | integer |
| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| title | string |
| status | integer |
| priority | integer |
| due_type | string Enum: "date" "datetime" |
| due_date | string or null <date> |
| due_at | string or null |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| external_id | string or null |
{- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "today",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "title",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "title",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "due_date",
- "direction": "asc"
}
]
}{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| title | string |
| status | integer |
| priority | integer |
| due_type | string Enum: "date" "datetime" |
| due_date | string or null <date> |
| due_at | string or null |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| external_id | string or null |
{- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}{- "data": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}Array of objects (Task) |
{- "resources": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "status": 0,
- "priority": 0,
- "due_type": "date",
- "due_date": "2019-08-24",
- "due_at": "string",
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| task required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| task required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| task required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| task required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| customer required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| task required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| task required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| task required | integer |
| employee required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| task required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| task required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "event",
- "direction": "asc"
}
]
}{- "data": [
- {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| webhook required | integer |
| url | string |
| event | any Enum: "created" "updated" "deleted" "restored" "saved" "all" |
Array of Array of arrays or strings or null Default: null | |
| columns_changed | Array of strings or null Default: null |
| description | string or null |
| active | integer |
{- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}{- "data": {
- "url": "string",
- "event": "created",
- "payload": null,
- "columns_changed": null,
- "description": "string",
- "active": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| subject | string |
| schedule_type | string Enum: "date" "datetime" |
| scheduled_date | string or null <date> |
| scheduled_at | string or null |
| contact_company_switch | integer |
| company_id | integer or null |
| contact_id | integer or null |
| mobile_phone_field | string or null |
| other_customer_name | string or null |
| other_phone_number | string or null |
| status | integer |
| priority | integer |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| is_followup | integer |
| external_id | string or null |
{- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string"
}{- "data": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "today",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "subject",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "subject",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "scheduled_date",
- "direction": "asc"
}
]
}{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| phonecall required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| subject | string |
| schedule_type | string Enum: "date" "datetime" |
| scheduled_date | string or null <date> |
| scheduled_at | string or null |
| contact_company_switch | integer |
| company_id | integer or null |
| contact_id | integer or null |
| mobile_phone_field | string or null |
| other_customer_name | string or null |
| other_phone_number | string or null |
| status | integer |
| priority | integer |
| description | string or null |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| project_status | any |
| project_bidding_id | integer or null |
| project_id | integer or null |
| is_followup | integer |
| external_id | string or null |
{- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string"
}{- "data": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| force | boolean |
{- "data": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
}{- "data": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
}Array of objects (PhoneCall) |
{- "resources": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string"
}
]
}{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string"
}
}
}{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "subject": "string",
- "schedule_type": "date",
- "scheduled_date": "2019-08-24",
- "scheduled_at": "string",
- "contact_company_switch": 0,
- "company_id": 0,
- "contact_id": 0,
- "mobile_phone_field": "string",
- "other_customer_name": "string",
- "other_phone_number": "string",
- "status": 0,
- "priority": 0,
- "description": "string",
- "permission": 1,
- "project_status": null,
- "project_bidding_id": 0,
- "project_id": 0,
- "is_followup": 0,
- "external_id": "string",
- "id": 0
}
]
}| phonecall required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| phonecall required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| phonecall required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| phonecall required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| phonecall required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| phonecall required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| phonecall required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| phonecall required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| phonecall required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| phonecall required | integer |
| employee required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "last_name": "string",
- "first_name": "string",
- "company_id": 0,
- "title": "string",
- "work_phone": "string",
- "mobile_phone": "string",
- "email": "string",
- "send_docs_from_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",
- "has_custom_employer_cost_markup": 0,
- "employer_cost_markup_percentage": null,
- "salary_custom_percentages": 0,
- "salary_secondary_percentage": null,
- "overtime_primary_percentage": null,
- "overtime_secondary_percentage": null,
- "permission": 1,
- "external_id": "string",
- "payable_public_holidays": 0,
- "payable_vacation_days_per_year": 0,
- "payable_vacation_days": null,
- "payable_sick_days_per_year": 0,
- "payable_sick_days": null,
- "payable_personal_days_per_year": 0,
- "payable_personal_days": null,
- "payable_days_last_update": "2019-08-24",
- "id": 0
}
}| phonecall required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
], - "updated": [
- 0
]
}| phonecall required | integer |
| resources | Array of objects |
{- "resources": [
- { }
]
}{- "attached": [
- 0
], - "detached": [
- 0
]
}| 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 |
{- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string"
}{- "data": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| warehouse required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
}| warehouse required | integer |
| 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 |
{- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string"
}{- "data": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
}| warehouse required | integer |
| force | boolean |
{- "data": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
}{- "data": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
}Array of objects (Warehouse) |
{- "resources": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string"
}
]
}{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string"
}
}
}{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "address_1": "string",
- "address_2": "string",
- "city": "string",
- "country_id": 0,
- "state_id": 0,
- "postcode": "string",
- "active": 0,
- "external_id": "string",
- "id": 0
}
]
}| name | string |
| barcode | string or null |
| minimum_threshold | any |
| requested_quantity | any |
| quantity | any |
| available_quantity | any |
| quantity_unit | string |
| last_purchase_id | integer or null |
| category_id | integer or null |
| suggested_sell_price | any |
| suggested_sell_price_currency | string or null |
| bom_enabled | integer |
| bom_labor_hours_per_unit | any |
| memo | string or null |
| external_id | string or null |
| warehouse_quantity | any |
{- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null
}{- "data": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects | |
Array of objects |
{- "scopes": [
- {
- "name": "on_stock",
- "parameters": [
- "string"
]
}
], - "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
}| inventory required | integer |
| name | string |
| barcode | string or null |
| minimum_threshold | any |
| requested_quantity | any |
| quantity | any |
| available_quantity | any |
| quantity_unit | string |
| last_purchase_id | integer or null |
| category_id | integer or null |
| suggested_sell_price | any |
| suggested_sell_price_currency | string or null |
| bom_enabled | integer |
| bom_labor_hours_per_unit | any |
| memo | string or null |
| external_id | string or null |
| warehouse_quantity | any |
{- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null
}{- "data": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
}| inventory required | integer |
| force | boolean |
{- "data": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
}{- "data": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
}Array of objects (Inventory) |
{- "resources": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null
}
]
}{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null
}
}
}{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "barcode": "string",
- "minimum_threshold": null,
- "requested_quantity": null,
- "quantity": null,
- "available_quantity": null,
- "quantity_unit": "string",
- "last_purchase_id": 0,
- "category_id": 0,
- "suggested_sell_price": null,
- "suggested_sell_price_currency": "string",
- "bom_enabled": 0,
- "bom_labor_hours_per_unit": null,
- "memo": "string",
- "external_id": "string",
- "warehouse_quantity": null,
- "id": 0
}
]
}| inventory required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| 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 |
{- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string"
}{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "type",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "type",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "type",
- "direction": "asc"
}
]
}{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| storage required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| storage required | integer |
| 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 |
{- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string"
}{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| storage required | integer |
| force | boolean |
{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| storage required | integer |
{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
Array of objects (InventoryStorage) |
{- "resources": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
object |
{- "resources": {
- "{key}": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| storage required | integer |
{- "data": {
- "inventory_id": 0,
- "type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| 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 |
| production_id | integer or null |
| total_cost | any |
| total_cost_currency | string or null |
| external_id | string or null |
{- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string"
}{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "storage_id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "storage_id",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "created_at",
- "direction": "asc"
}
]
}{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory required | integer |
| usage required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| usage required | integer |
| 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 |
| production_id | integer or null |
| total_cost | any |
| total_cost_currency | string or null |
| external_id | string or null |
{- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string"
}{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| usage required | integer |
| force | boolean |
{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| usage required | integer |
{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
Array of objects (InventoryUsage) |
{- "resources": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string"
}
]
}{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
object |
{- "resources": {
- "{key}": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string"
}
}
}{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
]
}| inventory required | integer |
{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| inventory required | integer |
| usage required | integer |
{- "data": {
- "inventory_id": 0,
- "storage_id": 0,
- "quantity": null,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "purchase_id": 0,
- "production_id": 0,
- "total_cost": null,
- "total_cost_currency": "string",
- "external_id": "string",
- "id": 0
}
}| name | string |
| external_id | string or null |
{- "name": "string",
- "external_id": "string"
}{- "data": {
- "name": "string",
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "name",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_category required | integer |
| name | string |
| external_id | string or null |
{- "name": "string",
- "external_id": "string"
}{- "data": {
- "name": "string",
- "external_id": "string",
- "id": 0
}
}Array of objects (InventoryCategory) |
{- "resources": [
- {
- "name": "string",
- "external_id": "string"
}
]
}{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "name": "string",
- "external_id": "string"
}
}
}{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "name": "string",
- "external_id": "string",
- "id": 0
}
]
}| 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 |
{- "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"
}{- "data": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects | |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "invoice_no",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "invoice_no",
- "operator": "<",
- "value": "string"
}
]
}
], - "sort": [
- {
- "field": "invoice_no",
- "direction": "asc"
}
]
}{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_purchase required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| 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 |
{- "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"
}{- "data": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| force | boolean |
{- "data": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
{- "data": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
}Array of objects (InventoryPurchase) |
{- "resources": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string"
}
]
}{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}object |
{- "resources": {
- "{key}": {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string"
}
}
}{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "vendor_id": 0,
- "invoice_no": "string",
- "delivery_note": "string",
- "date": "2019-08-24",
- "memo": "string",
- "status": "price_quote",
- "invoiced": 0,
- "assign": 0,
- "record_type": "App\\Tenant\\CRM\\Models\\Contact",
- "record_id": 0,
- "storage_type": "project",
- "warehouse_id": 0,
- "project_id": 0,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_purchase required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_purchase required | integer |
| note required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| note required | integer |
| title | string |
| note | any |
| files | Array of strings or null Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload. |
| permission | integer Default: 0 Enum: 1 2 3 1 - public, 2 - public (read-only), 3 - private |
| sticky | integer |
| category_id | integer or null |
| alert | integer |
| alert_grid | integer |
| alert_to | string or null <date> |
| alert_type | any |
| external_id | string or null |
{- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| note required | integer |
| force | boolean |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
Array of objects (Note) |
{- "resources": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
object |
{- "resources": {
- "{key}": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| note required | integer |
{- "data": {
- "title": "string",
- "note": null,
- "files": [
- "string"
], - "permission": 1,
- "sticky": 0,
- "category_id": 0,
- "alert": 0,
- "alert_grid": 0,
- "alert_to": "2019-08-24",
- "alert_type": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| 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 |
{- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string"
}{- "data": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_purchase required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
| page | integer Default: 1 |
| limit | integer Default: 20 |
Array of objects |
{- "filters": [
- {
- "type": "and",
- "field": "inventory_id",
- "operator": "<",
- "value": "string",
- "nested": [
- {
- "type": "and",
- "field": "inventory_id",
- "operator": "<",
- "value": "string"
}
]
}
]
}{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
], - "links": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}| inventory_purchase required | integer |
| row required | integer |
| with_trashed | boolean |
| only_trashed | boolean |
{- "data": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| row required | integer |
| 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 |
{- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string"
}{- "data": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| row required | integer |
| force | boolean |
{- "data": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
| row required | integer |
{- "data": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
}| inventory_purchase required | integer |
Array of objects (InventoryPurchaseRow) |
{- "resources": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string"
}
]
}{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
object |
{- "resources": {
- "{key}": {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string"
}
}
}{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
| force | boolean |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity": null,
- "used_quantity": null,
- "external_id": "string",
- "id": 0
}
]
}| inventory_purchase required | integer |
| resources | Array of integers |
{- "resources": [
- 0
]
}{- "data": [
- {
- "purchase_id": 0,
- "inventory_id": 0,
- "storage_id": 0,
- "unit_price": null,
- "unit_price_currency": "string",
- "quantity"