API docs by Redocly

Repzo API Collection (1.0.0)

Download OpenAPI specification:Download

Complete API documentation for Repzo platform

Activity AI Sales Order

Operations related to AI-assisted sales order activities

Get all AI sales order activities

Retrieve a list of all AI sales order activities with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new AI sales order activity

Create a new AI sales order activity with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID

rep
required
string

Sales representative ID

activityType
required
string
Enum: "recommendation" "order-analysis" "demand-forecasting" "cross-sell" "upsell"

Type of AI activity

object
object
object
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "activityType": "recommendation",
  • "inputData": {
    },
  • "aiModel": {
    },
  • "feedback": {
    },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get AI sales order activity by ID

Retrieve a specific AI sales order activity by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AI sales order activity ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update AI sales order activity

Update an existing AI sales order activity with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AI sales order activity ID

Request Body schema: application/json
client
required
string

Client ID

rep
required
string

Sales representative ID

activityType
required
string
Enum: "recommendation" "order-analysis" "demand-forecasting" "cross-sell" "upsell"

Type of AI activity

object
object
object
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "activityType": "recommendation",
  • "inputData": {
    },
  • "aiModel": {
    },
  • "feedback": {
    },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete AI sales order activity

Delete an existing AI sales order activity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AI sales order activity ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "AI sales order activity deleted successfully"
}

Generate AI recommendations

Generate AI-powered sales order recommendations for the activity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AI sales order activity ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Activity Feedback V2

Activity feedback v2 management operations

Get all activity feedback v2

Retrieve a list of all activity feedback v2 with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

client
string

Filter by client ID

overall_satisfaction
integer [ 1 .. 10 ]

Filter by overall satisfaction rating

template_id
string

Filter by feedback template ID

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create new activity feedback v2

Create a new activity feedback v2 entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
activity_type
required
string

Type of activity this feedback is for

activity_id
string

ID of the related activity

rep
required
string

Representative ID

client
string

Client ID

template_id
required
string

Feedback template ID used

overall_satisfaction
required
integer [ 1 .. 10 ]

Overall satisfaction rating (1-10 scale)

Array of objects
nps_score
integer [ 0 .. 10 ]

Net Promoter Score (0-10)

completion_time
integer

Time taken to complete feedback (in seconds)

object
is_anonymous
boolean
Default: false

Whether the feedback is anonymous

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "activity_type": "sales_visit",
  • "activity_id": "507f1f77bcf86cd799439012",
  • "rep": "507f1f77bcf86cd799439013",
  • "client": "507f1f77bcf86cd799439014",
  • "template_id": "507f1f77bcf86cd799439015",
  • "overall_satisfaction": 8,
  • "responses": [
    ],
  • "nps_score": 10,
  • "completion_time": 0,
  • "session_data": {
    },
  • "is_anonymous": false,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get activity feedback v2 by ID

Retrieve a specific activity feedback v2 by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update activity feedback v2

Update an existing activity feedback v2

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Request Body schema: application/json
overall_satisfaction
integer [ 1 .. 10 ]

Overall satisfaction rating (1-10 scale)

Array of objects
nps_score
integer [ 0 .. 10 ]

Net Promoter Score (0-10)

Array of objects
company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "overall_satisfaction": 1,
  • "responses": [
    ],
  • "nps_score": 10,
  • "follow_up_actions": [
    ],
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete activity feedback v2

Delete an activity feedback v2 by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get detailed feedback analytics

Get detailed analytics and insights for activity feedback v2

Authorizations:
ApiKeyAuth
query Parameters
date_from
string <date>

Start date for analytics

date_to
string <date>

End date for analytics

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

template_id
string

Filter by feedback template ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Activity Feedback

Activity feedback management operations

Get all activity feedback

Retrieve a list of all activity feedback with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

client
string

Filter by client ID

rating
integer [ 1 .. 5 ]

Filter by rating

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create new activity feedback

Create a new activity feedback entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
activity_type
required
string

Type of activity this feedback is for

activity_id
string

ID of the related activity

rep
required
string

Representative ID

client
string

Client ID

rating
required
integer [ 1 .. 5 ]

Feedback rating (1-5 scale)

feedback_text
string

Detailed feedback text

feedback_categories
Array of strings

Categories of feedback

is_anonymous
boolean
Default: false

Whether the feedback is anonymous

source
string
Default: "mobile_app"
Enum: "mobile_app" "web_portal" "email" "sms" "phone"

Source of the feedback

response_time
integer

Time taken to provide feedback (in seconds)

Array of objects
follow_up_required
boolean
Default: false

Whether follow-up is required

follow_up_notes
string

Notes for follow-up actions

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "activity_type": "sales_visit",
  • "activity_id": "507f1f77bcf86cd799439012",
  • "rep": "507f1f77bcf86cd799439013",
  • "client": "507f1f77bcf86cd799439014",
  • "rating": 4,
  • "feedback_text": "Great service, very professional",
  • "feedback_categories": [
    ],
  • "is_anonymous": false,
  • "source": "mobile_app",
  • "response_time": 0,
  • "attachments": [
    ],
  • "follow_up_required": false,
  • "follow_up_notes": "string",
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get activity feedback by ID

Retrieve a specific activity feedback by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update activity feedback

Update an existing activity feedback

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Request Body schema: application/json
rating
integer [ 1 .. 5 ]

Feedback rating (1-5 scale)

feedback_text
string

Detailed feedback text

feedback_categories
Array of strings

Categories of feedback

follow_up_required
boolean

Whether follow-up is required

follow_up_notes
string

Notes for follow-up actions

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "rating": 1,
  • "feedback_text": "string",
  • "feedback_categories": [
    ],
  • "follow_up_required": true,
  • "follow_up_notes": "string",
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete activity feedback

Delete an activity feedback by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get feedback analytics

Get analytics and statistics for activity feedback

Authorizations:
ApiKeyAuth
query Parameters
date_from
string <date>

Start date for analytics

date_to
string <date>

End date for analytics

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Activity Storecheck

Operations related to activity storecheck management

Get all activity storecheck records

Retrieve a list of all activity storecheck records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new activity storecheck record

Create a new activity storecheck record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client identifier

rep
required
string

Sales representative identifier

template
required
string

Storecheck template identifier

date
required
string <date-time>

Date and time of the storecheck activity

object
Array of objects
status
string
Default: "draft"
Enum: "draft" "submitted" "approved" "rejected"

Status of the storecheck activity

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "date": "2023-01-15T10:30:00Z",
  • "location": {
    },
  • "responses": [
    ],
  • "status": "draft",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get activity storecheck record by ID

Retrieve a specific activity storecheck record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update activity storecheck record

Update an existing activity storecheck record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Request Body schema: application/json
client
required
string

Client identifier

rep
required
string

Sales representative identifier

template
required
string

Storecheck template identifier

date
required
string <date-time>

Date and time of the storecheck activity

object
Array of objects
status
string
Default: "draft"
Enum: "draft" "submitted" "approved" "rejected"

Status of the storecheck activity

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "date": "2023-01-15T10:30:00Z",
  • "location": {
    },
  • "responses": [
    ],
  • "status": "draft",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete activity storecheck record

Delete an existing activity storecheck record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Activity storecheck record deleted successfully"
}

Asset Part Receival

Operations related to asset part receival management

Get all asset part receivals

Retrieve a list of all asset part receivals with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part receival

Create a new asset part receival with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
receivalNumber
required
string

Unique receival number

purchaseOrder
string

Purchase order reference

supplier
required
string

Supplier ID

receivalDate
required
string <date-time>

Date and time of receival

expectedDate
string <date-time>

Expected delivery date

receivedBy
string

User who received the parts

warehouse
string

Warehouse ID where parts were received

status
string
Default: "pending"
Enum: "pending" "partial" "complete" "cancelled"

Status of the receival

required
Array of objects
totalValue
number <double> >= 0

Total value of the receival

currency
string

Currency code

shippingCost
number <double> >= 0

Shipping cost

taxAmount
number <double> >= 0

Tax amount

discountAmount
number <double> >= 0

Discount amount

object
object
Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "receivalNumber": "RCV-2023-001",
  • "purchaseOrder": "PO-2023-001",
  • "supplier": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "receivalDate": "2023-01-15T10:00:00Z",
  • "expectedDate": "2023-01-14T10:00:00Z",
  • "receivedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "warehouse": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "currency": "USD",
  • "shippingCost": 0,
  • "taxAmount": 0,
  • "discountAmount": 0,
  • "invoice": {
    },
  • "qualityCheck": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part receival by ID

Retrieve a specific asset part receival by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part receival

Update an existing asset part receival with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Request Body schema: application/json
receivalNumber
required
string

Unique receival number

purchaseOrder
string

Purchase order reference

supplier
required
string

Supplier ID

receivalDate
required
string <date-time>

Date and time of receival

expectedDate
string <date-time>

Expected delivery date

receivedBy
string

User who received the parts

warehouse
string

Warehouse ID where parts were received

status
string
Default: "pending"
Enum: "pending" "partial" "complete" "cancelled"

Status of the receival

required
Array of objects
totalValue
number <double> >= 0

Total value of the receival

currency
string

Currency code

shippingCost
number <double> >= 0

Shipping cost

taxAmount
number <double> >= 0

Tax amount

discountAmount
number <double> >= 0

Discount amount

object
object
Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "receivalNumber": "RCV-2023-001",
  • "purchaseOrder": "PO-2023-001",
  • "supplier": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "receivalDate": "2023-01-15T10:00:00Z",
  • "expectedDate": "2023-01-14T10:00:00Z",
  • "receivedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "warehouse": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "currency": "USD",
  • "shippingCost": 0,
  • "taxAmount": 0,
  • "discountAmount": 0,
  • "invoice": {
    },
  • "qualityCheck": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part receival

Delete an existing asset part receival

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part receival deleted successfully"
}

Asset Part Transfer

Operations related to asset part transfer management

Get all asset part transfers

Retrieve a list of all asset part transfers with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part transfer

Create a new asset part transfer with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
transferNumber
required
string

Unique transfer number

required
object
required
object
requestedBy
required
string

User who requested the transfer

approvedBy
string

User who approved the transfer

transferredBy
string

User who executed the transfer

requestDate
string <date-time>

Date when transfer was requested

approvalDate
string <date-time>

Date when transfer was approved

transferDate
string <date-time>

Date when transfer was executed

scheduledDate
string <date-time>

Scheduled transfer date

status
string
Default: "requested"
Enum: "requested" "approved" "in-progress" "completed" "cancelled"

Status of the transfer

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Priority of the transfer

reason
string

Reason for the transfer

required
Array of objects
totalItems
integer >= 0

Total number of items being transferred

transportMethod
string
Default: "manual"
Enum: "manual" "vehicle" "courier" "automated"

Method of transport

carrier
string

Carrier/transporter name

trackingNumber
string

Tracking number if applicable

estimatedArrival
string <date-time>

Estimated arrival time

actualArrival
string <date-time>

Actual arrival time

cost
number <double> >= 0

Transfer cost

currency
string

Currency code

Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "transferNumber": "TRF-2023-001",
  • "fromLocation": {
    },
  • "toLocation": {
    },
  • "requestedBy": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "approvedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "transferredBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "requestDate": "2023-01-15T08:00:00Z",
  • "approvalDate": "2023-01-15T09:00:00Z",
  • "transferDate": "2023-01-15T10:00:00Z",
  • "scheduledDate": "2023-01-15T10:00:00Z",
  • "status": "requested",
  • "priority": "low",
  • "reason": "string",
  • "items": [
    ],
  • "totalItems": 0,
  • "transportMethod": "manual",
  • "carrier": "string",
  • "trackingNumber": "string",
  • "estimatedArrival": "2019-08-24T14:15:22Z",
  • "actualArrival": "2019-08-24T14:15:22Z",
  • "cost": 0,
  • "currency": "USD",
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part transfer by ID

Retrieve a specific asset part transfer by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part transfer

Update an existing asset part transfer with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Request Body schema: application/json
transferNumber
required
string

Unique transfer number

required
object
required
object
requestedBy
required
string

User who requested the transfer

approvedBy
string

User who approved the transfer

transferredBy
string

User who executed the transfer

requestDate
string <date-time>

Date when transfer was requested

approvalDate
string <date-time>

Date when transfer was approved

transferDate
string <date-time>

Date when transfer was executed

scheduledDate
string <date-time>

Scheduled transfer date

status
string
Default: "requested"
Enum: "requested" "approved" "in-progress" "completed" "cancelled"

Status of the transfer

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Priority of the transfer

reason
string

Reason for the transfer

required
Array of objects
totalItems
integer >= 0

Total number of items being transferred

transportMethod
string
Default: "manual"
Enum: "manual" "vehicle" "courier" "automated"

Method of transport

carrier
string

Carrier/transporter name

trackingNumber
string

Tracking number if applicable

estimatedArrival
string <date-time>

Estimated arrival time

actualArrival
string <date-time>

Actual arrival time

cost
number <double> >= 0

Transfer cost

currency
string

Currency code

Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "transferNumber": "TRF-2023-001",
  • "fromLocation": {
    },
  • "toLocation": {
    },
  • "requestedBy": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "approvedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "transferredBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "requestDate": "2023-01-15T08:00:00Z",
  • "approvalDate": "2023-01-15T09:00:00Z",
  • "transferDate": "2023-01-15T10:00:00Z",
  • "scheduledDate": "2023-01-15T10:00:00Z",
  • "status": "requested",
  • "priority": "low",
  • "reason": "string",
  • "items": [
    ],
  • "totalItems": 0,
  • "transportMethod": "manual",
  • "carrier": "string",
  • "trackingNumber": "string",
  • "estimatedArrival": "2019-08-24T14:15:22Z",
  • "actualArrival": "2019-08-24T14:15:22Z",
  • "cost": 0,
  • "currency": "USD",
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part transfer

Delete an existing asset part transfer

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part transfer deleted successfully"
}

Complete asset part transfer

Mark an asset part transfer as completed

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Asset Part Type

Operations related to asset part type management

Get all asset part types

Retrieve a list of all asset part types with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part type

Create a new asset part type with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the asset part type

description
string

Description of the asset part type

category
required
string

Category of the asset part type

subcategory
string

Subcategory of the asset part type

object

Technical specifications

compatibleAssetTypes
Array of strings

List of compatible asset type IDs

object
warrantPeriod
integer

Warranty period in days

supplier
string

Default supplier ID

standardCost
number <double> >= 0

Standard cost of the part

isActive
boolean
Default: true

Whether the part type is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Engine Parts",
  • "description": "string",
  • "category": "Mechanical",
  • "subcategory": "string",
  • "specifications": {
    },
  • "compatibleAssetTypes": [
    ],
  • "maintenanceSchedule": {
    },
  • "warrantPeriod": 365,
  • "supplier": "string",
  • "standardCost": 0,
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part type by ID

Retrieve a specific asset part type by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part type

Update an existing asset part type with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Request Body schema: application/json
name
required
string

Name of the asset part type

description
string

Description of the asset part type

category
required
string

Category of the asset part type

subcategory
string

Subcategory of the asset part type

object

Technical specifications

compatibleAssetTypes
Array of strings

List of compatible asset type IDs

object
warrantPeriod
integer

Warranty period in days

supplier
string

Default supplier ID

standardCost
number <double> >= 0

Standard cost of the part

isActive
boolean
Default: true

Whether the part type is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Engine Parts",
  • "description": "string",
  • "category": "Mechanical",
  • "subcategory": "string",
  • "specifications": {
    },
  • "compatibleAssetTypes": [
    ],
  • "maintenanceSchedule": {
    },
  • "warrantPeriod": 365,
  • "supplier": "string",
  • "standardCost": 0,
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part type

Delete an existing asset part type

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part type deleted successfully"
}

Asset Part Unit

Operations related to asset part unit management

Get all asset part units

Retrieve a list of all asset part units with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part unit

Create a new asset part unit with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
serialNumber
required
string

Serial number of the part unit

assetPart
required
string

Asset part ID this unit belongs to

batchNumber
string

Batch number

lotNumber
string

Lot number

manufactureDate
string <date>

Manufacturing date

expiryDate
string <date>

Expiry date (if applicable)

receiptDate
string <date-time>

Date when the unit was received

status
required
string
Default: "available"
Enum: "available" "reserved" "in-use" "maintenance" "disposed" "returned"

Current status of the part unit

condition
string
Default: "new"
Enum: "new" "good" "fair" "poor" "damaged"

Physical condition of the part unit

object
object
installationDate
string <date-time>

Date when the unit was installed

lastMaintenanceDate
string <date-time>

Last maintenance date

nextMaintenanceDate
string <date-time>

Next scheduled maintenance date

warrantyExpiry
string <date>

Warranty expiry date

cost
number <double> >= 0

Cost of this specific unit

supplier
string

Supplier ID

purchaseOrder
string

Purchase order reference

invoice
string

Invoice reference

notes
string

Additional notes

object

Custom fields

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "SN-EP001-2023-001",
  • "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "batchNumber": "BATCH-2023-001",
  • "lotNumber": "string",
  • "manufactureDate": "2023-01-15",
  • "expiryDate": "2019-08-24",
  • "receiptDate": "2023-01-20T10:00:00Z",
  • "status": "available",
  • "condition": "new",
  • "location": {
    },
  • "assignedTo": {
    },
  • "installationDate": "2019-08-24T14:15:22Z",
  • "lastMaintenanceDate": "2019-08-24T14:15:22Z",
  • "nextMaintenanceDate": "2019-08-24T14:15:22Z",
  • "warrantyExpiry": "2019-08-24",
  • "cost": 0,
  • "supplier": "string",
  • "purchaseOrder": "string",
  • "invoice": "string",
  • "notes": "string",
  • "customFields": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part unit by ID

Retrieve a specific asset part unit by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part unit

Update an existing asset part unit with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Request Body schema: application/json
serialNumber
required
string

Serial number of the part unit

assetPart
required
string

Asset part ID this unit belongs to

batchNumber
string

Batch number

lotNumber
string

Lot number

manufactureDate
string <date>

Manufacturing date

expiryDate
string <date>

Expiry date (if applicable)

receiptDate
string <date-time>

Date when the unit was received

status
required
string
Default: "available"
Enum: "available" "reserved" "in-use" "maintenance" "disposed" "returned"

Current status of the part unit

condition
string
Default: "new"
Enum: "new" "good" "fair" "poor" "damaged"

Physical condition of the part unit

object
object
installationDate
string <date-time>

Date when the unit was installed

lastMaintenanceDate
string <date-time>

Last maintenance date

nextMaintenanceDate
string <date-time>

Next scheduled maintenance date

warrantyExpiry
string <date>

Warranty expiry date

cost
number <double> >= 0

Cost of this specific unit

supplier
string

Supplier ID

purchaseOrder
string

Purchase order reference

invoice
string

Invoice reference

notes
string

Additional notes

object

Custom fields

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "SN-EP001-2023-001",
  • "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "batchNumber": "BATCH-2023-001",
  • "lotNumber": "string",
  • "manufactureDate": "2023-01-15",
  • "expiryDate": "2019-08-24",
  • "receiptDate": "2023-01-20T10:00:00Z",
  • "status": "available",
  • "condition": "new",
  • "location": {
    },
  • "assignedTo": {
    },
  • "installationDate": "2019-08-24T14:15:22Z",
  • "lastMaintenanceDate": "2019-08-24T14:15:22Z",
  • "nextMaintenanceDate": "2019-08-24T14:15:22Z",
  • "warrantyExpiry": "2019-08-24",
  • "cost": 0,
  • "supplier": "string",
  • "purchaseOrder": "string",
  • "invoice": "string",
  • "notes": "string",
  • "customFields": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part unit

Delete an existing asset part unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part unit deleted successfully"
}

Asset Part

Operations related to asset part management

Get all asset parts

Retrieve a list of all asset parts with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part

Create a new asset part with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partNumber
required
string

Unique part number

name
required
string

Name of the asset part

description
string

Description of the asset part

partType
required
string

Asset part type ID

manufacturer
string

Manufacturer name

model
string

Part model number

object

Technical specifications

compatibleAssets
Array of strings

List of compatible asset IDs

supplier
string

Primary supplier ID

cost
number <double> >= 0

Current cost of the part

currency
string

Currency code

minStockLevel
integer >= 0

Minimum stock level

maxStockLevel
integer >= 0

Maximum stock level

reorderPoint
integer >= 0

Reorder point threshold

leadTime
integer

Lead time in days

warrantyPeriod
integer

Warranty period in days

category
string

Part category

subcategory
string

Part subcategory

isActive
boolean
Default: true

Whether the part is active

barcode
string

Barcode for the part

qrCode
string

QR code for the part

images
Array of strings <uri>

Part images URLs

Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "partNumber": "EP-001-2023",
  • "name": "Engine Valve",
  • "description": "string",
  • "partType": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "manufacturer": "ABC Manufacturing",
  • "model": "string",
  • "specifications": {
    },
  • "compatibleAssets": [
    ],
  • "supplier": "string",
  • "cost": 0,
  • "currency": "USD",
  • "minStockLevel": 0,
  • "maxStockLevel": 0,
  • "reorderPoint": 0,
  • "leadTime": 7,
  • "warrantyPeriod": 365,
  • "category": "Engine",
  • "subcategory": "Valves",
  • "isActive": true,
  • "barcode": "string",
  • "qrCode": "string",
  • "images": [],
  • "documents": [],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part by ID

Retrieve a specific asset part by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part

Update an existing asset part with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Request Body schema: application/json
partNumber
required
string

Unique part number

name
required
string

Name of the asset part

description
string

Description of the asset part

partType
required
string

Asset part type ID

manufacturer
string

Manufacturer name

model
string

Part model number

object

Technical specifications

compatibleAssets
Array of strings

List of compatible asset IDs

supplier
string

Primary supplier ID

cost
number <double> >= 0

Current cost of the part

currency
string

Currency code

minStockLevel
integer >= 0

Minimum stock level

maxStockLevel
integer >= 0

Maximum stock level

reorderPoint
integer >= 0

Reorder point threshold

leadTime
integer

Lead time in days

warrantyPeriod
integer

Warranty period in days

category
string

Part category

subcategory
string

Part subcategory

isActive
boolean
Default: true

Whether the part is active

barcode
string

Barcode for the part

qrCode
string

QR code for the part

images
Array of strings <uri>

Part images URLs

Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "partNumber": "EP-001-2023",
  • "name": "Engine Valve",
  • "description": "string",
  • "partType": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "manufacturer": "ABC Manufacturing",
  • "model": "string",
  • "specifications": {
    },
  • "compatibleAssets": [
    ],
  • "supplier": "string",
  • "cost": 0,
  • "currency": "USD",
  • "minStockLevel": 0,
  • "maxStockLevel": 0,
  • "reorderPoint": 0,
  • "leadTime": 7,
  • "warrantyPeriod": 365,
  • "category": "Engine",
  • "subcategory": "Valves",
  • "isActive": true,
  • "barcode": "string",
  • "qrCode": "string",
  • "images": [],
  • "documents": [],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part

Delete an existing asset part

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part deleted successfully"
}

Asset Unit

Asset unit management operations

Get all asset units

Retrieve a list of all asset units with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

asset
string

Filter by asset ID

status
string
Enum: "active" "maintenance" "retired" "disposed"

Filter by status

location
string

Filter by location

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new asset unit

Create a new asset unit entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
asset
required
string

Asset ID reference

serial_number
required
string

Unique serial number for this unit

barcode
string

Barcode identifier

status
string
Default: "active"
Enum: "active" "maintenance" "retired" "disposed"

Initial status of the asset unit

condition
string
Default: "good"
Enum: "excellent" "good" "fair" "poor"

Physical condition of the asset

location
string

Current location of the asset unit

assigned_to
string

User or department assigned to this asset

purchase_date
string <date>

Date when the asset unit was purchased

warranty_expiry
string <date>

Warranty expiration date

purchase_cost
number <float>

Original purchase cost

object
notes
string

Additional notes about the asset unit

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the asset unit is disabled

Responses

Request samples

Content type
application/json
{
  • "asset": "507f1f77bcf86cd799439012",
  • "serial_number": "AST-001-2024",
  • "barcode": "string",
  • "status": "active",
  • "condition": "excellent",
  • "location": "string",
  • "assigned_to": "string",
  • "purchase_date": "2019-08-24",
  • "warranty_expiry": "2019-08-24",
  • "purchase_cost": 0,
  • "depreciation": {
    },
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset unit by ID

Retrieve a specific asset unit by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset unit

Update an existing asset unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Request Body schema: application/json
serial_number
string

Unique serial number for this unit

barcode
string

Barcode identifier

status
string
Enum: "active" "maintenance" "retired" "disposed"

Status of the asset unit

condition
string
Enum: "excellent" "good" "fair" "poor"

Physical condition of the asset

location
string

Current location of the asset unit

assigned_to
string

User or department assigned to this asset

purchase_date
string <date>

Date when the asset unit was purchased

warranty_expiry
string <date>

Warranty expiration date

last_maintenance
string <date-time>

Date of last maintenance

next_maintenance
string <date>

Date of next scheduled maintenance

purchase_cost
number <float>

Original purchase cost

object
notes
string

Additional notes about the asset unit

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the asset unit is disabled

Responses

Request samples

Content type
application/json
{
  • "serial_number": "string",
  • "barcode": "string",
  • "status": "active",
  • "condition": "excellent",
  • "location": "string",
  • "assigned_to": "string",
  • "purchase_date": "2019-08-24",
  • "warranty_expiry": "2019-08-24",
  • "last_maintenance": "2019-08-24T14:15:22Z",
  • "next_maintenance": "2019-08-24",
  • "purchase_cost": 0,
  • "depreciation": {
    },
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset unit

Delete an asset unit by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete asset units

Delete multiple asset units by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of asset unit IDs to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Update asset unit status

Update the status of an asset unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Request Body schema: application/json
status
required
string
Enum: "active" "maintenance" "retired" "disposed"

New status for the asset unit

reason
string

Reason for status change

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "reason": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Channel

Client channel management operations

Get all client channels

Retrieve a list of all client channels with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

string or Array of strings

Filter by channel ID(s)

search
string

Search text for channel name

string or Array of strings

Filter by channel name(s)

string or Array of strings

Filter by local name(s)

disabled
boolean

Filter by disabled status

from_updatedAt
integer <int64>

Filter channels updated after this timestamp

from__id
string

Filter channels with ID greater than this value

to__id
string

Filter channels with ID less than this value

Array of objects

Advanced sorting options

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Create a new client channel

Create a new client channel

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Channel name (required)

local_name
string

Local/translated name

disabled
boolean

Whether the channel is disabled

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this channel belongs to

Responses

Request samples

Content type
application/json
{
  • "name": "Retail Channel",
  • "local_name": "قناة التجزئة",
  • "disabled": false,
  • "integration_meta": {
    },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get a specific client channel

Retrieve a specific client channel by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a client channel

Update an existing client channel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Request Body schema: application/json
name
string

Channel name

local_name
string

Local/translated name

disabled
boolean

Whether the channel is disabled

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this channel belongs to

_id
string

Channel ID (for internal use)

createdAt
string <date-time>

Creation timestamp (for internal use)

updatedAt
string <date-time>

Last update timestamp (for internal use)

__v
integer

Version key (for internal use)

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Retail Channel",
  • "local_name": "قناة التجزئة المحدثة",
  • "disabled": false,
  • "integration_meta": {
    },
  • "company_namespace": [
    ],
  • "_id": "60f1b2b3c9e9a12345678901",
  • "createdAt": "2023-01-15T10:30:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a client channel

Delete an existing client channel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Client Contact

Client contact management operations

Get all client contacts

Retrieve a list of all client contacts with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

string or Array of strings

Filter by contact ID(s)

search
string

Search text for contact name

string or Array of strings

Filter by contact name(s)

from_updatedAt
integer <int64>

Filter contacts updated after this timestamp

to_updatedAt
integer <int64>

Filter contacts updated before this timestamp

from__id
string

Filter contacts with ID greater than this value

to__id
string

Filter contacts with ID less than this value

Array of objects

Advanced sorting options

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Create a new client contact

Create a new client contact

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Contact name (required)

AdminCreator (object) or RepCreator (object) or ClientCreator (object)

User who created this contact

AdminCreator (object) or RepCreator (object) or ClientCreator (object)

User who last edited this contact

local_name
string

Local/translated name

phone1
string

Primary phone number

phone2
string

Secondary phone number

email
string <email>

Email address

title
string

Job title or position

extra_info
string

Additional information about the contact

disabled
boolean

Whether the contact is disabled

media
Array of strings

Array of media file URLs

cover_photo
string

Cover photo URL

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this contact belongs to

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith",
  • "creator": {
    },
  • "editor": {
    },
  • "local_name": "جون سميث",
  • "phone1": "+1234567890",
  • "phone2": "+1234567891",
  • "email": "john.smith@example.com",
  • "title": "Sales Manager",
  • "extra_info": "Primary contact for technical issues",
  • "disabled": false,
  • "media": [],
  • "cover_photo": "https://example.com/cover.jpg",
  • "integration_meta": {
    },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get a specific client contact

Retrieve a specific client contact by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client contact ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a client contact

Update an existing client contact

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client contact ID

Request Body schema: application/json
name
string

Contact name

AdminCreator (object) or RepCreator (object) or ClientCreator (object)

User who created this contact

AdminCreator (object) or RepCreator (object) or ClientCreator (object)

User who last edited this contact

local_name
string

Local/translated name

phone1
string

Primary phone number

phone2
string

Secondary phone number

email
string <email>

Email address

title
string

Job title or position

extra_info
string

Additional information about the contact

disabled
boolean

Whether the contact is disabled

media
Array of strings

Array of media file URLs

cover_photo
string

Cover photo URL

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this contact belongs to

_id
string

Contact ID (for internal use)

createdAt
string <date-time>

Creation timestamp (for internal use)

updatedAt
string <date-time>

Last update timestamp (for internal use)

__v
integer

Version key (for internal use)

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith Updated",
  • "creator": {
    },
  • "editor": {
    },
  • "local_name": "جون سميث محدث",
  • "phone1": "+1234567890",
  • "phone2": "+1234567891",
  • "email": "john.smith.updated@example.com",
  • "title": "Senior Sales Manager",
  • "extra_info": "Primary contact for technical issues - updated",
  • "disabled": false,
  • "media": [],
  • "cover_photo": "https://example.com/cover-updated.jpg",
  • "integration_meta": {
    },
  • "company_namespace": [
    ],
  • "_id": "60f1b2b3c9e9a12345678901",
  • "createdAt": "2023-01-15T10:30:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a client contact

Delete an existing client contact

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client contact ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Client Location

Client location management operations

Get all client locations

Retrieve a list of all client locations with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

client
string

Filter by client ID

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new client location

Create a new client location entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID

name
required
string

Location name

address
required
string

Street address

city
string

City name

state
string

State or province

postal_code
string

Postal or ZIP code

country
string

Country name

object
is_primary
boolean
Default: false

Whether this is the primary location

location_type
string
Default: "office"
Enum: "office" "warehouse" "retail" "branch" "other"

Type of location

object
object
notes
string

Additional notes about the location

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the location is disabled

Responses

Request samples

Content type
application/json
{
  • "client": "507f1f77bcf86cd799439012",
  • "name": "Main Office",
  • "address": "123 Main St",
  • "city": "New York",
  • "state": "NY",
  • "postal_code": "10001",
  • "country": "United States",
  • "coordinates": {
    },
  • "is_primary": false,
  • "location_type": "office",
  • "contact_info": {
    },
  • "business_hours": {
    },
  • "notes": "string",
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get client location by ID

Retrieve a specific client location by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update client location

Update an existing client location

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Request Body schema: application/json
name
string

Location name

address
string

Street address

city
string

City name

state
string

State or province

postal_code
string

Postal or ZIP code

country
string

Country name

object
is_primary
boolean

Whether this is the primary location

location_type
string
Enum: "office" "warehouse" "retail" "branch" "other"

Type of location

object
object
notes
string

Additional notes about the location

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the location is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string",
  • "coordinates": {
    },
  • "is_primary": true,
  • "location_type": "office",
  • "contact_info": {
    },
  • "business_hours": {
    },
  • "notes": "string",
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete client location

Delete a client location by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete client locations

Delete multiple client locations by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of client location IDs to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Contract Installment

Contract installment management operations

Get all contract installments

Retrieve a list of all contract installments with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

contract
string

Filter by contract ID

status
string
Enum: "pending" "paid" "overdue" "cancelled"

Filter by payment status

due_date_from
string <date>

Filter by due date from

due_date_to
string <date>

Filter by due date to

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new contract installment

Create a new contract installment

Authorizations:
ApiKeyAuth
Request Body schema: application/json
contract
required
string

Contract ID reference

installment_number
required
integer

Installment sequence number

due_date
required
string <date>

Due date for this installment

amount
required
number <float>

Installment amount

currency
string
Default: "USD"

Currency code

late_fee
number <float>
Default: 0

Late fee charged if overdue

discount_applied
number <float>
Default: 0

Discount applied to this installment

interest_rate
number <float>
Default: 0

Interest rate for this installment

grace_period_days
integer
Default: 0

Grace period in days before marking overdue

auto_pay_enabled
boolean
Default: false

Whether auto-pay is enabled for this installment

notes
string

Additional notes

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "contract": "507f1f77bcf86cd799439012",
  • "installment_number": 1,
  • "due_date": "2024-01-15",
  • "amount": 1500,
  • "currency": "USD",
  • "late_fee": 0,
  • "discount_applied": 0,
  • "interest_rate": 0,
  • "grace_period_days": 0,
  • "auto_pay_enabled": false,
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get contract installment by ID

Retrieve a specific contract installment by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update contract installment

Update an existing contract installment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Request Body schema: application/json
due_date
string <date>

Due date for this installment

amount
number <float>

Installment amount

status
string
Enum: "pending" "paid" "overdue" "cancelled"

Payment status

payment_date
string <date>

Date when payment was made

payment_amount
number <float>

Amount actually paid

payment_method
string
Enum: "cash" "check" "credit_card" "bank_transfer" "other"

Payment method used

payment_reference
string

Payment reference number

late_fee
number <float>

Late fee charged if overdue

discount_applied
number <float>

Discount applied to this installment

interest_rate
number <float>

Interest rate for this installment

grace_period_days
integer

Grace period in days before marking overdue

auto_pay_enabled
boolean

Whether auto-pay is enabled for this installment

notes
string

Additional notes

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "due_date": "2019-08-24",
  • "amount": 0,
  • "status": "pending",
  • "payment_date": "2019-08-24",
  • "payment_amount": 0,
  • "payment_method": "cash",
  • "payment_reference": "string",
  • "late_fee": 0,
  • "discount_applied": 0,
  • "interest_rate": 0,
  • "grace_period_days": 0,
  • "auto_pay_enabled": true,
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete contract installment

Delete a contract installment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Mark installment as paid

Mark a contract installment as paid

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Contract installment ID

Request Body schema: application/json
payment_date
required
string <date>

Date of payment

payment_amount
required
number <float>

Amount paid

payment_method
string
Enum: "cash" "check" "credit_card" "bank_transfer" "other"

Payment method used

payment_reference
string

Payment reference number

notes
string

Payment notes

Responses

Request samples

Content type
application/json
{
  • "payment_date": "2019-08-24",
  • "payment_amount": 0,
  • "payment_method": "cash",
  • "payment_reference": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get overdue installments

Get all overdue contract installments

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

days_overdue
integer >= 0

Minimum days overdue

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Feedback Options

Feedback options management operations

Get all feedback options

Retrieve a list of all feedback options with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

category
string

Filter by category

is_active
boolean

Filter by active status

template_type
string
Enum: "survey" "rating" "nps" "custom"

Filter by template type

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create new feedback options

Create a new feedback options template

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Template name

description
string

Template description

category
string

Category of the template

template_type
required
string
Enum: "survey" "rating" "nps" "custom"

Type of feedback template

required
Array of objects (FeedbackQuestion)
object
object
object
is_active
boolean
Default: true

Whether the template is active

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "name": "Sales Visit Feedback",
  • "description": "string",
  • "category": "string",
  • "template_type": "survey",
  • "questions": [
    ],
  • "settings": {
    },
  • "styling": {
    },
  • "notification_settings": {
    },
  • "is_active": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get feedback options by ID

Retrieve a specific feedback options template by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Feedback options ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update feedback options

Update an existing feedback options template

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Feedback options ID

Request Body schema: application/json
name
string

Template name

description
string

Template description

category
string

Category of the template

Array of objects (FeedbackQuestion)
object
object
object
is_active
boolean

Whether the template is active

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "questions": [
    ],
  • "settings": {
    },
  • "styling": {
    },
  • "notification_settings": {
    },
  • "is_active": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete feedback options

Delete a feedback options template by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Feedback options ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Preview feedback template

Get a preview of how the feedback template will appear

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Feedback options ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get predefined templates

Get a list of predefined feedback templates

Authorizations:
ApiKeyAuth
query Parameters
category
string

Filter by category

template_type
string
Enum: "survey" "rating" "nps" "custom"

Filter by template type

Responses

Response samples

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

Integration Action Log

Operations related to integration action log management

Get all integration action log records

Retrieve a list of all integration action log records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration action log record

Create a new integration action log record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
integrationId
required
string

Integration identifier

actionType
required
string
Enum: "create" "update" "delete" "sync" "webhook"

Type of action performed

entityType
required
string

Type of entity affected

entityId
string

ID of the affected entity

status
required
string
Enum: "pending" "success" "failed" "retrying"

Status of the action

object

Action payload data

object

Response data from the action

errorMessage
string

Error message if action failed

retryCount
integer >= 0
Default: 0

Number of retry attempts

executionTime
number

Execution time in milliseconds

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "actionType": "create",
  • "entityType": "product",
  • "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "status": "success",
  • "payload": { },
  • "response": { },
  • "errorMessage": "string",
  • "retryCount": 0,
  • "executionTime": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration action log record by ID

Retrieve a specific integration action log record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration action log record

Update an existing integration action log record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Request Body schema: application/json
integrationId
required
string

Integration identifier

actionType
required
string
Enum: "create" "update" "delete" "sync" "webhook"

Type of action performed

entityType
required
string

Type of entity affected

entityId
string

ID of the affected entity

status
required
string
Enum: "pending" "success" "failed" "retrying"

Status of the action

object

Action payload data

object

Response data from the action

errorMessage
string

Error message if action failed

retryCount
integer >= 0
Default: 0

Number of retry attempts

executionTime
number

Execution time in milliseconds

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "actionType": "create",
  • "entityType": "product",
  • "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "status": "success",
  • "payload": { },
  • "response": { },
  • "errorMessage": "string",
  • "retryCount": 0,
  • "executionTime": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration action log record

Delete an existing integration action log record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration action log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration action log record deleted successfully"
}

Integration Command Log

Operations related to integration command log management

Get all integration command log records

Retrieve a list of all integration command log records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration command log record

Create a new integration command log record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
integrationId
required
string

Integration identifier

commandType
required
string
Enum: "sync" "import" "export" "validate" "transform"

Type of command executed

command
required
string

The actual command that was executed

object

Command parameters

status
required
string
Enum: "pending" "running" "completed" "failed" "cancelled"

Status of the command execution

startTime
string <date-time>

Command start time

endTime
string <date-time>

Command end time

duration
number

Command execution duration in milliseconds

object

Command output data

errorLog
string

Error log if command failed

processedRecords
integer >= 0

Number of records processed

failedRecords
integer >= 0

Number of records that failed processing

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "commandType": "sync",
  • "command": "sync-products",
  • "parameters": { },
  • "status": "completed",
  • "startTime": "2023-01-15T08:00:00Z",
  • "endTime": "2023-01-15T08:05:00Z",
  • "duration": 300000,
  • "output": { },
  • "errorLog": "string",
  • "processedRecords": 0,
  • "failedRecords": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration command log record by ID

Retrieve a specific integration command log record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration command log record

Update an existing integration command log record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Request Body schema: application/json
integrationId
required
string

Integration identifier

commandType
required
string
Enum: "sync" "import" "export" "validate" "transform"

Type of command executed

command
required
string

The actual command that was executed

object

Command parameters

status
required
string
Enum: "pending" "running" "completed" "failed" "cancelled"

Status of the command execution

startTime
string <date-time>

Command start time

endTime
string <date-time>

Command end time

duration
number

Command execution duration in milliseconds

object

Command output data

errorLog
string

Error log if command failed

processedRecords
integer >= 0

Number of records processed

failedRecords
integer >= 0

Number of records that failed processing

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "commandType": "sync",
  • "command": "sync-products",
  • "parameters": { },
  • "status": "completed",
  • "startTime": "2023-01-15T08:00:00Z",
  • "endTime": "2023-01-15T08:05:00Z",
  • "duration": 300000,
  • "output": { },
  • "errorLog": "string",
  • "processedRecords": 0,
  • "failedRecords": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration command log record

Delete an existing integration command log record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration command log record deleted successfully"
}

Mail Unsubscribe

Email unsubscription management operations

Get all unsubscribed emails

Retrieve a list of all unsubscribed email addresses with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

email
string

Filter by email address

company_namespace
Array of strings

Company namespace for filtering

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Add email to unsubscribe list

Add an email address to the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string <email>

Email address to unsubscribe

reason
string

Reason for unsubscribing

unsubscribe_types
Array of strings
Default: ["all"]

Types of emails to unsubscribe from

company_namespace
Array of strings

Company namespace

user_agent
string

User agent of the request

ip_address
string

IP address of the request

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "reason": "User requested unsubscribe",
  • "unsubscribe_types": [
    ],
  • "company_namespace": [
    ],
  • "user_agent": "string",
  • "ip_address": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get unsubscribe record by ID

Retrieve a specific unsubscribe record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Unsubscribe record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Remove email from unsubscribe list

Remove an email address from the unsubscribe list (re-subscribe)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Unsubscribe record ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk remove emails from unsubscribe list

Remove multiple email addresses from the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of unsubscribe record IDs to remove

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Check if email is unsubscribed

Check if an email address is in the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string <email>

Email address to check

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

OCR Invoice Job Group

Operations related to OCR invoice job group management

Get all OCR invoice job groups

Retrieve a list of all OCR invoice job groups with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new OCR invoice job group

Create a new OCR invoice job group with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the job group

description
string

Description of the job group

batchNumber
string

Batch number for tracking

template
required
string

OCR template ID to use for this group

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

object
object
createdBy
string

User who created the job group

assignedTo
string

User assigned to manage this group

tags
Array of strings

Tags for categorization

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Monthly Invoice Batch - January 2023",
  • "description": "string",
  • "batchNumber": "BATCH-2023-001",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "priority": "low",
  • "processingSettings": {
    },
  • "notifications": {
    },
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "tags": [
    ],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR invoice job group by ID

Retrieve a specific OCR invoice job group by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job group ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update OCR invoice job group

Update an existing OCR invoice job group with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job group ID

Request Body schema: application/json
name
required
string

Name of the job group

description
string

Description of the job group

batchNumber
string

Batch number for tracking

template
required
string

OCR template ID to use for this group

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

object
object
createdBy
string

User who created the job group

assignedTo
string

User assigned to manage this group

tags
Array of strings

Tags for categorization

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Monthly Invoice Batch - January 2023",
  • "description": "string",
  • "batchNumber": "BATCH-2023-001",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "priority": "low",
  • "processingSettings": {
    },
  • "notifications": {
    },
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "tags": [
    ],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete OCR invoice job group

Delete an existing OCR invoice job group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job group ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "OCR invoice job group deleted successfully"
}

Get jobs in a group

Retrieve all OCR jobs belonging to a specific group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job group ID

Responses

Response samples

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

OCR Invoice Job Page

Operations related to individual pages within OCR invoice jobs

Get all OCR invoice job pages

Retrieve a list of all OCR invoice job pages with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new OCR invoice job page

Create a new OCR invoice job page with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
job
required
string

OCR invoice job ID this page belongs to

pageNumber
required
integer >= 1

Page number within the document

pageUrl
required
string <uri>

URL of the page image

pageType
string
Enum: "cover" "header" "content" "footer" "summary" "attachment"

Type of page content

object
Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "job": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "pageNumber": 1,
  • "pageUrl": "https://storage.example.com/pages/invoice_2023_001_page_1.png",
  • "pageType": "content",
  • "imageProperties": {
    },
  • "annotations": [
    ],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR invoice job page by ID

Retrieve a specific OCR invoice job page by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update OCR invoice job page

Update an existing OCR invoice job page with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Request Body schema: application/json
job
required
string

OCR invoice job ID this page belongs to

pageNumber
required
integer >= 1

Page number within the document

pageUrl
required
string <uri>

URL of the page image

pageType
string
Enum: "cover" "header" "content" "footer" "summary" "attachment"

Type of page content

object
Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "job": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "pageNumber": 1,
  • "pageUrl": "https://storage.example.com/pages/invoice_2023_001_page_1.png",
  • "pageType": "content",
  • "imageProperties": {
    },
  • "annotations": [
    ],
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete OCR invoice job page

Delete an existing OCR invoice job page

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "OCR invoice job page deleted successfully"
}

Process OCR invoice job page

Start processing a specific page of an OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

OCR Invoice Job Template

Operations related to OCR invoice job template management

Get all OCR invoice job templates

Retrieve a list of all OCR invoice job templates with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new OCR invoice job template

Create a new OCR invoice job template with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the template

description
string

Description of the template

version
string

Template version

ocrEngine
required
string
Enum: "tesseract" "google-vision" "aws-textract" "azure-cognitive" "custom"

OCR engine to use

documentType
required
string
Enum: "invoice" "receipt" "bill" "statement" "other"

Type of document

required
object
object
object
supportedFormats
Array of strings
Items Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Supported document formats

languages
Array of strings

Supported languages for OCR

isActive
boolean
Default: true

Whether the template is active

isDefault
boolean
Default: false

Whether this is the default template

createdBy
string

User who created the template

lastModifiedBy
string

User who last modified the template

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Standard Invoice OCR Template",
  • "description": "string",
  • "version": "1.0.0",
  • "ocrEngine": "google-vision",
  • "documentType": "invoice",
  • "extractionRules": {
    },
  • "preprocessingSettings": {
    },
  • "postprocessingSettings": {
    },
  • "supportedFormats": [
    ],
  • "languages": [
    ],
  • "isActive": true,
  • "isDefault": false,
  • "createdBy": "string",
  • "lastModifiedBy": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR invoice job template by ID

Retrieve a specific OCR invoice job template by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job template ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update OCR invoice job template

Update an existing OCR invoice job template with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job template ID

Request Body schema: application/json
name
required
string

Name of the template

description
string

Description of the template

version
string

Template version

ocrEngine
required
string
Enum: "tesseract" "google-vision" "aws-textract" "azure-cognitive" "custom"

OCR engine to use

documentType
required
string
Enum: "invoice" "receipt" "bill" "statement" "other"

Type of document

required
object
object
object
supportedFormats
Array of strings
Items Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Supported document formats

languages
Array of strings

Supported languages for OCR

isActive
boolean
Default: true

Whether the template is active

isDefault
boolean
Default: false

Whether this is the default template

createdBy
string

User who created the template

lastModifiedBy
string

User who last modified the template

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Standard Invoice OCR Template",
  • "description": "string",
  • "version": "1.0.0",
  • "ocrEngine": "google-vision",
  • "documentType": "invoice",
  • "extractionRules": {
    },
  • "preprocessingSettings": {
    },
  • "postprocessingSettings": {
    },
  • "supportedFormats": [
    ],
  • "languages": [
    ],
  • "isActive": true,
  • "isDefault": false,
  • "createdBy": "string",
  • "lastModifiedBy": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete OCR invoice job template

Delete an existing OCR invoice job template

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job template ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "OCR invoice job template deleted successfully"
}

OCR Invoice Job

Operations related to individual OCR invoice job management

Get all OCR invoice jobs

Retrieve a list of all OCR invoice jobs with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new OCR invoice job

Create a new OCR invoice job with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
jobNumber
required
string

Unique job number

documentName
required
string

Name of the document being processed

documentUrl
required
string <uri>

URL of the document to process

documentType
string
Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Type of document

template
required
string

OCR template ID to use

group
string

OCR job group ID if part of a batch

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

createdBy
string

User who created the job

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "jobNumber": "OCR-2023-001",
  • "documentName": "invoice_2023_001.pdf",
  • "documentUrl": "https://storage.example.com/invoices/invoice_2023_001.pdf",
  • "documentType": "pdf",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "group": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "priority": "low",
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR invoice job by ID

Retrieve a specific OCR invoice job by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update OCR invoice job

Update an existing OCR invoice job with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Request Body schema: application/json
jobNumber
required
string

Unique job number

documentName
required
string

Name of the document being processed

documentUrl
required
string <uri>

URL of the document to process

documentType
string
Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Type of document

template
required
string

OCR template ID to use

group
string

OCR job group ID if part of a batch

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

createdBy
string

User who created the job

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "jobNumber": "OCR-2023-001",
  • "documentName": "invoice_2023_001.pdf",
  • "documentUrl": "https://storage.example.com/invoices/invoice_2023_001.pdf",
  • "documentType": "pdf",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "group": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "priority": "low",
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete OCR invoice job

Delete an existing OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "OCR invoice job deleted successfully"
}

Process OCR invoice job

Start processing an OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR results

Retrieve the OCR processing results for a job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Patch Action

Operations related to patch action management

Get all patch action records

Retrieve a list of all patch action records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new patch action

Create a new patch action with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the patch action

description
string

Description of what the patch action does

targetEntity
required
string

The entity type this patch targets

object

Conditions that must be met for the patch to apply

required
Array of objects
batchSize
integer [ 1 .. 1000 ]
Default: 100

Number of records to process in each batch

status
string
Default: "draft"
Enum: "draft" "ready" "running" "completed" "failed" "cancelled"

Status of the patch action

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update Product Prices",
  • "description": "string",
  • "targetEntity": "product",
  • "conditions": { },
  • "patches": [
    ],
  • "batchSize": 100,
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get patch action by ID

Retrieve a specific patch action by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update patch action

Update an existing patch action with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Request Body schema: application/json
name
required
string

Name of the patch action

description
string

Description of what the patch action does

targetEntity
required
string

The entity type this patch targets

object

Conditions that must be met for the patch to apply

required
Array of objects
batchSize
integer [ 1 .. 1000 ]
Default: 100

Number of records to process in each batch

status
string
Default: "draft"
Enum: "draft" "ready" "running" "completed" "failed" "cancelled"

Status of the patch action

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update Product Prices",
  • "description": "string",
  • "targetEntity": "product",
  • "conditions": { },
  • "patches": [
    ],
  • "batchSize": 100,
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete patch action

Delete an existing patch action

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Patch action deleted successfully"
}

Execute patch action

Execute a specific patch action by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Product Modifiers Group

Product modifier group management operations

Get all product modifier groups

Retrieve a list of all product modifier groups with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new product modifier group

Create a new product modifier group entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Product modifier group name

description
string

Group description

Array of objects
is_required
boolean
Default: false

Whether selecting a modifier from this group is required

max_selection
integer
Default: 1

Maximum number of modifiers that can be selected

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the group is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Size Options",
  • "description": "Available size options for products",
  • "modifiers": [
    ],
  • "is_required": false,
  • "max_selection": 1,
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get product modifier group by ID

Retrieve a specific product modifier group by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update product modifier group

Update an existing product modifier group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Request Body schema: application/json
name
string

Product modifier group name

description
string

Group description

Array of objects
is_required
boolean

Whether selecting a modifier from this group is required

max_selection
integer

Maximum number of modifiers that can be selected

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the group is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Size Options",
  • "description": "string",
  • "modifiers": [
    ],
  • "is_required": true,
  • "max_selection": 0,
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete product modifier group

Delete a product modifier group by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete product modifier groups

Delete multiple product modifier groups by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of product modifier group IDs to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Return Asset Part Unit

Operations related to returning asset part units

Get all asset part unit returns

Retrieve a list of all asset part unit returns with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part unit return

Create a new asset part unit return with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
returnNumber
required
string

Unique return number

assetPartUnit
required
string

Asset part unit ID being returned

serialNumber
string

Serial number of the part unit

returnType
required
string
Enum: "warranty" "defective" "excess" "end-of-lease" "maintenance"

Type of return

returnReason
required
string

Reason for return

returnedBy
required
string

User who initiated the return

authorizedBy
string

User who authorized the return

returnDate
string <date-time>

Date when the return was processed

requestDate
string <date-time>

Date when the return was requested

originalInstallDate
string <date-time>

Original installation date

originalWorkOrder
string

Original work order ID

originalAsset
string

Original asset ID where it was installed

status
string
Default: "requested"
Enum: "requested" "approved" "in-transit" "received" "processed" "completed" "rejected"

Status of the return

condition
string
Enum: "new" "good" "fair" "poor" "damaged" "defective"

Condition of the returned part

object
supplier
string

Supplier ID if returning to supplier

creditAmount
number <double> >= 0

Credit amount for the return

currency
string

Currency code

replacementRequired
boolean
Default: false

Whether a replacement is required

replacementPartUnit
string

Replacement part unit ID if applicable

warrantyStatus
string
Enum: "in-warranty" "out-of-warranty" "extended-warranty"

Warranty status at time of return

object
Array of objects
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "returnNumber": "RET-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "returnType": "defective",
  • "returnReason": "Part failed after 30 days of use",
  • "returnedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "returnDate": "2023-01-15T10:00:00Z",
  • "requestDate": "2023-01-14T10:00:00Z",
  • "originalInstallDate": "2023-01-01T10:00:00Z",
  • "originalWorkOrder": "60f7b1b3e4b0e8b3f8b3f8b7",
  • "originalAsset": "60f7b1b3e4b0e8b3f8b3f8b8",
  • "status": "requested",
  • "condition": "defective",
  • "returnLocation": {
    },
  • "supplier": "string",
  • "creditAmount": 0,
  • "currency": "USD",
  • "replacementRequired": false,
  • "replacementPartUnit": "string",
  • "warrantyStatus": "in-warranty",
  • "qualityInspection": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part unit return by ID

Retrieve a specific asset part unit return by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part unit return

Update an existing asset part unit return with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Request Body schema: application/json
returnNumber
required
string

Unique return number

assetPartUnit
required
string

Asset part unit ID being returned

serialNumber
string

Serial number of the part unit

returnType
required
string
Enum: "warranty" "defective" "excess" "end-of-lease" "maintenance"

Type of return

returnReason
required
string

Reason for return

returnedBy
required
string

User who initiated the return

authorizedBy
string

User who authorized the return

returnDate
string <date-time>

Date when the return was processed

requestDate
string <date-time>

Date when the return was requested

originalInstallDate
string <date-time>

Original installation date

originalWorkOrder
string

Original work order ID

originalAsset
string

Original asset ID where it was installed

status
string
Default: "requested"
Enum: "requested" "approved" "in-transit" "received" "processed" "completed" "rejected"

Status of the return

condition
string
Enum: "new" "good" "fair" "poor" "damaged" "defective"

Condition of the returned part

object
supplier
string

Supplier ID if returning to supplier

creditAmount
number <double> >= 0

Credit amount for the return

currency
string

Currency code

replacementRequired
boolean
Default: false

Whether a replacement is required

replacementPartUnit
string

Replacement part unit ID if applicable

warrantyStatus
string
Enum: "in-warranty" "out-of-warranty" "extended-warranty"

Warranty status at time of return

object
Array of objects
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "returnNumber": "RET-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "returnType": "defective",
  • "returnReason": "Part failed after 30 days of use",
  • "returnedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "returnDate": "2023-01-15T10:00:00Z",
  • "requestDate": "2023-01-14T10:00:00Z",
  • "originalInstallDate": "2023-01-01T10:00:00Z",
  • "originalWorkOrder": "60f7b1b3e4b0e8b3f8b3f8b7",
  • "originalAsset": "60f7b1b3e4b0e8b3f8b3f8b8",
  • "status": "requested",
  • "condition": "defective",
  • "returnLocation": {
    },
  • "supplier": "string",
  • "creditAmount": 0,
  • "currency": "USD",
  • "replacementRequired": false,
  • "replacementPartUnit": "string",
  • "warrantyStatus": "in-warranty",
  • "qualityInspection": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part unit return

Delete an existing asset part unit return

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part unit return deleted successfully"
}

Safe Invoice Serial Counter

Safe invoice serial counter management operations

Get all safe invoice serial counters

Retrieve a list of all safe invoice serial counters with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

rep
string

Filter by representative ID

warehouse
string

Filter by warehouse ID

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new safe invoice serial counter

Create a new safe invoice serial counter entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
rep
required
string

Representative ID

warehouse
required
string

Warehouse ID

invoice_type
required
string
Enum: "sales" "return" "proforma"

Type of invoice

current_serial
integer
Default: 0

Starting serial number

prefix
string

Serial number prefix

suffix
string

Serial number suffix

pad_length
integer
Default: 6

Length to pad the serial number

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "rep": "507f1f77bcf86cd799439012",
  • "warehouse": "507f1f77bcf86cd799439013",
  • "invoice_type": "sales",
  • "current_serial": 0,
  • "prefix": "INV-2024-",
  • "suffix": "string",
  • "pad_length": 6,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get safe invoice serial counter by ID

Retrieve a specific safe invoice serial counter by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Safe invoice serial counter ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update safe invoice serial counter

Update an existing safe invoice serial counter

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Safe invoice serial counter ID

Request Body schema: application/json
current_serial
integer

Current serial number

prefix
string

Serial number prefix

suffix
string

Serial number suffix

pad_length
integer

Length to pad the serial number

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "current_serial": 0,
  • "prefix": "string",
  • "suffix": "string",
  • "pad_length": 0,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete safe invoice serial counter

Delete a safe invoice serial counter by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Safe invoice serial counter ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get next serial number

Get the next available serial number for invoice generation

Authorizations:
ApiKeyAuth
Request Body schema: application/json
rep
required
string

Representative ID

warehouse
required
string

Warehouse ID

invoice_type
required
string
Enum: "sales" "return" "proforma"

Type of invoice

Responses

Request samples

Content type
application/json
{
  • "rep": "string",
  • "warehouse": "string",
  • "invoice_type": "sales"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Speciality

Speciality management operations

Get all specialities

Retrieve a list of all specialities with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new speciality

Create a new speciality entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Speciality name

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the speciality is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Cardiology",
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get speciality by ID

Retrieve a specific speciality by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update speciality

Update an existing speciality

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Request Body schema: application/json
name
string

Speciality name

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the speciality is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Cardiology",
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete speciality

Delete a speciality by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete specialities

Delete multiple specialities by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of speciality IDs to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Store Asset Part Unit

Operations related to storing asset part units

Get all asset part unit storage records

Retrieve a list of all asset part unit storage records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part unit storage record

Create a new asset part unit storage record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
storageNumber
required
string

Unique storage number

assetPartUnit
required
string

Asset part unit ID being stored

serialNumber
string

Serial number of the part unit

storageType
required
string
Enum: "inventory" "spare" "buffer" "quarantine" "maintenance"

Type of storage

storageReason
string

Reason for storage

storedBy
required
string

User who stored the part

authorizedBy
string

User who authorized the storage

storageDate
string <date-time>

Date when the part was stored

expectedRetrievalDate
string <date-time>

Expected retrieval date

required
object
status
string
Default: "stored"
Enum: "stored" "reserved" "allocated" "picked" "expired"

Current storage status

condition
string
Enum: "new" "good" "fair" "poor" "damaged"

Condition when stored

object
preservationMethod
string
Default: "none"
Enum: "none" "plastic-wrap" "desiccant" "vacuum-seal" "oil-coating"

Preservation method used

lastInspectionDate
string <date-time>

Last inspection date

nextInspectionDate
string <date-time>

Next scheduled inspection date

object
tags
Array of strings

Storage tags for categorization

barcode
string

Storage barcode

qrCode
string

Storage QR code

weight
number <double> >= 0

Weight of the stored item

object
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "storageNumber": "STR-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "storageType": "inventory",
  • "storageReason": "New inventory received",
  • "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "storageDate": "2023-01-15T10:00:00Z",
  • "expectedRetrievalDate": "2023-06-15T10:00:00Z",
  • "location": {
    },
  • "status": "stored",
  • "condition": "new",
  • "storageEnvironment": {
    },
  • "preservationMethod": "none",
  • "lastInspectionDate": "2019-08-24T14:15:22Z",
  • "nextInspectionDate": "2019-08-24T14:15:22Z",
  • "reservedFor": {
    },
  • "tags": [
    ],
  • "barcode": "string",
  • "qrCode": "string",
  • "weight": 0,
  • "dimensions": {
    },
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part unit storage record by ID

Retrieve a specific asset part unit storage record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit storage record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part unit storage record

Update an existing asset part unit storage record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit storage record ID

Request Body schema: application/json
storageNumber
required
string

Unique storage number

assetPartUnit
required
string

Asset part unit ID being stored

serialNumber
string

Serial number of the part unit

storageType
required
string
Enum: "inventory" "spare" "buffer" "quarantine" "maintenance"

Type of storage

storageReason
string

Reason for storage

storedBy
required
string

User who stored the part

authorizedBy
string

User who authorized the storage

storageDate
string <date-time>

Date when the part was stored

expectedRetrievalDate
string <date-time>

Expected retrieval date

required
object
status
string
Default: "stored"
Enum: "stored" "reserved" "allocated" "picked" "expired"

Current storage status

condition
string
Enum: "new" "good" "fair" "poor" "damaged"

Condition when stored

object
preservationMethod
string
Default: "none"
Enum: "none" "plastic-wrap" "desiccant" "vacuum-seal" "oil-coating"

Preservation method used

lastInspectionDate
string <date-time>

Last inspection date

nextInspectionDate
string <date-time>

Next scheduled inspection date

object
tags
Array of strings

Storage tags for categorization

barcode
string

Storage barcode

qrCode
string

Storage QR code

weight
number <double> >= 0

Weight of the stored item

object
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "storageNumber": "STR-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "storageType": "inventory",
  • "storageReason": "New inventory received",
  • "storedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "storageDate": "2023-01-15T10:00:00Z",
  • "expectedRetrievalDate": "2023-06-15T10:00:00Z",
  • "location": {
    },
  • "status": "stored",
  • "condition": "new",
  • "storageEnvironment": {
    },
  • "preservationMethod": "none",
  • "lastInspectionDate": "2019-08-24T14:15:22Z",
  • "nextInspectionDate": "2019-08-24T14:15:22Z",
  • "reservedFor": {
    },
  • "tags": [
    ],
  • "barcode": "string",
  • "qrCode": "string",
  • "weight": 0,
  • "dimensions": {
    },
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part unit storage record

Delete an existing asset part unit storage record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit storage record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part unit storage record deleted successfully"
}

Svix Integration

Operations related to Svix webhook integration management

Get all Svix integration records

Retrieve a list of all Svix integration records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new Svix integration

Create a new Svix integration with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the integration

description
string

Description of the integration

applicationId
required
string

Svix application ID

endpointUrl
required
string <uri>

Webhook endpoint URL

eventTypes
Array of strings

List of event types to subscribe to

secret
string

Webhook secret for signature verification

isActive
boolean
Default: true

Whether the integration is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Webhook Integration",
  • "description": "string",
  • "applicationId": "app_12345",
  • "endpointUrl": "https://example.com/webhook",
  • "eventTypes": [
    ],
  • "secret": "string",
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Svix integration by ID

Retrieve a specific Svix integration by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update Svix integration

Update an existing Svix integration with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Request Body schema: application/json
name
required
string

Name of the integration

description
string

Description of the integration

applicationId
required
string

Svix application ID

endpointUrl
required
string <uri>

Webhook endpoint URL

eventTypes
Array of strings

List of event types to subscribe to

secret
string

Webhook secret for signature verification

isActive
boolean
Default: true

Whether the integration is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Webhook Integration",
  • "description": "string",
  • "applicationId": "app_12345",
  • "endpointUrl": "https://example.com/webhook",
  • "eventTypes": [
    ],
  • "secret": "string",
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete Svix integration

Delete an existing Svix integration

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Svix integration deleted successfully"
}

Update Integration Meta

Operations related to updating integration metadata

Get all integration meta update records

Retrieve a list of all integration metadata update records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration meta update

Create a new integration metadata update with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the meta update

description
string

Description of the meta update

targetIntegrations
Array of strings

List of integration IDs to update

required
object

Metadata fields to update

object

Conditions for applying the update

status
string
Default: "draft"
Enum: "draft" "ready" "applied" "failed" "cancelled"

Status of the meta update

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update API Version",
  • "description": "string",
  • "targetIntegrations": [
    ],
  • "metaUpdates": {
    },
  • "conditions": { },
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration meta update by ID

Retrieve a specific integration metadata update by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration meta update

Update an existing integration metadata update with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Request Body schema: application/json
name
required
string

Name of the meta update

description
string

Description of the meta update

targetIntegrations
Array of strings

List of integration IDs to update

required
object

Metadata fields to update

object

Conditions for applying the update

status
string
Default: "draft"
Enum: "draft" "ready" "applied" "failed" "cancelled"

Status of the meta update

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update API Version",
  • "description": "string",
  • "targetIntegrations": [
    ],
  • "metaUpdates": {
    },
  • "conditions": { },
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration meta update

Delete an existing integration metadata update

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration meta update deleted successfully"
}

Apply integration meta update

Apply a specific integration metadata update

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Workorder Category

Workorder category management operations

Get all workorder categories

Retrieve a list of all workorder categories with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

disabled
boolean

Filter by disabled status

parent_category
string

Filter by parent category ID

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new workorder category

Create a new workorder category

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Category name

description
string

Category description

code
string

Category code for identification

parent_category
string

Parent category ID for hierarchical structure

color
string

Color code for visual identification

icon
string

Icon identifier

priority_level
integer [ 1 .. 5 ]
Default: 3

Default priority level for workorders in this category

estimated_duration
integer

Estimated duration in minutes

required_skills
Array of strings

Skills required for this category

default_assignee
string

Default assignee for this category

object
approval_required
boolean
Default: false

Whether approval is required for workorders in this category

Array of objects
object
sort_order
integer
Default: 0

Sort order for display

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the category is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Maintenance",
  • "description": "General maintenance workorders",
  • "code": "MAINT",
  • "parent_category": "string",
  • "color": "#FF5733",
  • "icon": "wrench",
  • "priority_level": 3,
  • "estimated_duration": 0,
  • "required_skills": [
    ],
  • "default_assignee": "string",
  • "notification_settings": {
    },
  • "approval_required": false,
  • "custom_fields": [
    ],
  • "sla_settings": {
    },
  • "sort_order": 0,
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get workorder category by ID

Retrieve a specific workorder category by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder category ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update workorder category

Update an existing workorder category

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder category ID

Request Body schema: application/json
name
string

Category name

description
string

Category description

code
string

Category code for identification

parent_category
string

Parent category ID for hierarchical structure

color
string

Color code for visual identification

icon
string

Icon identifier

priority_level
integer [ 1 .. 5 ]

Default priority level for workorders in this category

estimated_duration
integer

Estimated duration in minutes

required_skills
Array of strings

Skills required for this category

default_assignee
string

Default assignee for this category

object
approval_required
boolean

Whether approval is required for workorders in this category

Array of objects
object
sort_order
integer

Sort order for display

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the category is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "code": "string",
  • "parent_category": "string",
  • "color": "string",
  • "icon": "string",
  • "priority_level": 1,
  • "estimated_duration": 0,
  • "required_skills": [
    ],
  • "default_assignee": "string",
  • "notification_settings": {
    },
  • "approval_required": true,
  • "custom_fields": [
    ],
  • "sla_settings": {
    },
  • "sort_order": 0,
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete workorder category

Delete a workorder category by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder category ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete workorder categories

Delete multiple workorder categories by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of workorder category IDs to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

Get category hierarchy

Get workorder categories in hierarchical structure

Authorizations:
ApiKeyAuth

Responses

Response samples

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

Get all workorder portal links

Retrieve a list of all workorder portal links with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

workorder
string

Filter by workorder ID

is_active
boolean

Filter by active status

link_type
string
Enum: "public" "private" "secure"

Filter by link type

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new workorder portal link

Create a new workorder portal link

Authorizations:
ApiKeyAuth
Request Body schema: application/json
workorder
required
string

Workorder ID reference

link_type
string
Default: "private"
Enum: "public" "private" "secure"

Type of portal link

object
object
expiry_date
string <date-time>

When the portal link expires

object
object
object
is_active
boolean
Default: true

Whether the portal link is active

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "workorder": "507f1f77bcf86cd799439012",
  • "link_type": "public",
  • "permissions": {
    },
  • "access_restrictions": {
    },
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notification_settings": {
    },
  • "custom_branding": {
    },
  • "metadata": {
    },
  • "is_active": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get workorder portal link by ID

Retrieve a specific workorder portal link by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update workorder portal link

Update an existing workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Request Body schema: application/json
link_type
string
Enum: "public" "private" "secure"

Type of portal link

object
object
expiry_date
string <date-time>

When the portal link expires

is_active
boolean

Whether the portal link is active

object
object
object
company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "link_type": "public",
  • "permissions": {
    },
  • "access_restrictions": {
    },
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "notification_settings": {
    },
  • "custom_branding": {
    },
  • "metadata": {
    },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete workorder portal link

Delete a workorder portal link by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Regenerate portal link

Regenerate the portal link URL and access token

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Activate portal link

Activate a workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Deactivate portal link

Deactivate a workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Workorder Portal

Workorder portal management operations

Get workorder portal entries

Retrieve workorder portal entries with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

status
string
Enum: "pending" "in_progress" "completed" "cancelled"

Filter by status

workorder
string

Filter by workorder ID

client
string

Filter by client ID

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new workorder portal entry

Create a new workorder portal entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
workorder
required
string

Workorder ID reference

client
required
string

Client ID reference

access_level
string
Default: "view_only"
Enum: "view_only" "comment" "full_access"

Level of access granted

allowed_actions
Array of strings
Default: ["view"]
Items Enum: "view" "comment" "upload_files" "approve" "reject"

Actions allowed for this portal access

expiry_date
string <date-time>

When portal access expires

object
object
object
company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether portal access is disabled

Responses

Request samples

Content type
application/json
{
  • "workorder": "507f1f77bcf86cd799439012",
  • "client": "507f1f77bcf86cd799439013",
  • "access_level": "view_only",
  • "allowed_actions": [
    ],
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notifications": {
    },
  • "portal_settings": {
    },
  • "custom_branding": {
    },
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get workorder portal entry by ID

Retrieve a specific workorder portal entry by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update workorder portal entry

Update an existing workorder portal entry

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Request Body schema: application/json
status
string
Enum: "pending" "in_progress" "completed" "cancelled"

Current status

access_level
string
Enum: "view_only" "comment" "full_access"

Level of access granted

allowed_actions
Array of strings
Items Enum: "view" "comment" "upload_files" "approve" "reject"
expiry_date
string <date-time>

When portal access expires

object
object
object
company_namespace
Array of strings

Company namespace

disabled
boolean

Whether portal access is disabled

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "access_level": "view_only",
  • "allowed_actions": [
    ],
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notifications": {
    },
  • "portal_settings": {
    },
  • "custom_branding": {
    },
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete workorder portal entry

Delete a workorder portal entry by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Update workorder portal status

Update the status of a workorder portal entry

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Request Body schema: application/json
status
required
string
Enum: "pending" "in_progress" "completed" "cancelled"

New status

notes
string

Status update notes

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Find account adjustments

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering account adjustments

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create an account adjustment

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID whose account is being adjusted

rep
string

Representative ID who made the adjustment

type
required
string
Enum: "credit" "debit"

Type of adjustment (credit increases balance, debit decreases)

amount
required
number

Adjustment amount

reason
required
string

Reason for the adjustment

reference
string

Reference number or document

description
string

Detailed description of the adjustment

adjustmentDate
string <date-time>

Date when adjustment was made

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "previousBalance": 0,
  • "newBalance": 0,
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "approvedBy": "string",
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get an account adjustment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "previousBalance": 0,
  • "newBalance": 0,
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "approvedBy": "string",
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find inventory adjustments

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering inventory adjustments

Responses

Response samples

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

Create an inventory adjustment

Authorizations:
ApiKeyAuth
Request Body schema: application/json
warehouse
string
rep
string
Array of objects
notes
string

Responses

Request samples

Content type
application/json
{
  • "warehouse": "string",
  • "rep": "string",
  • "items": [
    ],
  • "notes": "string"
}

Response samples

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

Get an inventory adjustment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Find approval requests

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering approval requests

Responses

Response samples

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

Create an approval request

Authorizations:
ApiKeyAuth
Request Body schema: application/json
title
string
description
string
requestedBy
string
entity
string
entityId
string
approvers
Array of strings
requiredApprovals
number
dueDate
string <date-time>
priority
string
Enum: "low" "medium" "high" "urgent"

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "requestedBy": "string",
  • "entity": "string",
  • "entityId": "string",
  • "approvers": [
    ],
  • "requiredApprovals": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "priority": "low"
}

Response samples

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

Get an approval request by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an approval request

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
title
string
description
string
approvers
Array of strings
requiredApprovals
number
dueDate
string <date-time>
priority
string
Enum: "low" "medium" "high" "urgent"
status
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "approvers": [
    ],
  • "requiredApprovals": 0,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "priority": "low",
  • "status": "string"
}

Response samples

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

Remove an approval request

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find approvals

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering approvals

Responses

Response samples

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

Create an approval

Authorizations:
ApiKeyAuth
Request Body schema: application/json
approvalRequest
string
approver
string
decision
string
Enum: "approved" "rejected"
comments
string
signedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "approvalRequest": "string",
  • "approver": "string",
  • "decision": "approved",
  • "comments": "string",
  • "signedAt": "2019-08-24T14:15:22Z"
}

Response samples

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

Get an approval by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an approval

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
decision
string
Enum: "approved" "rejected"
comments
string
signedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "decision": "approved",
  • "comments": "string",
  • "signedAt": "2019-08-24T14:15:22Z"
}

Response samples

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

Remove an approval

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find asset types

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering asset types

Responses

Response samples

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

Create an asset type

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
description
string
category
string
fields
Array of objects
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "fields": [
    ],
  • "disabled": true
}

Response samples

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

Get an asset type by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an asset type

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
description
string
category
string
fields
Array of objects
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "fields": [
    ],
  • "disabled": true
}

Response samples

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

Remove an asset type

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find assets

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering assets

Responses

Response samples

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

Create an asset

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
serialNumber
string
assetType
string
client
string
location
object
status
string
purchaseDate
string <date-time>
warrantyExpiry
string <date-time>
customFields
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serialNumber": "string",
  • "assetType": "string",
  • "client": "string",
  • "location": { },
  • "status": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "warrantyExpiry": "2019-08-24T14:15:22Z",
  • "customFields": { }
}

Response samples

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

Get an asset by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an asset

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
serialNumber
string
assetType
string
client
string
location
object
status
string
purchaseDate
string <date-time>
warrantyExpiry
string <date-time>
customFields
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serialNumber": "string",
  • "assetType": "string",
  • "client": "string",
  • "location": { },
  • "status": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "warrantyExpiry": "2019-08-24T14:15:22Z",
  • "customFields": { }
}

Response samples

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

Remove an asset

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find banks

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering banks

Responses

Response samples

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

Create a bank

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
code
string
country
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "country": "string",
  • "disabled": true
}

Response samples

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

Get a bank by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a bank

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
code
string
country
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "country": "string",
  • "disabled": true
}

Response samples

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

Remove a bank

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find bank lists

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering bank lists

Responses

Response samples

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

Create a bank list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
banks
Array of strings
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "banks": [
    ],
  • "disabled": true
}

Response samples

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

Get a bank list by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a bank list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
banks
Array of strings
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "banks": [
    ],
  • "disabled": true
}

Response samples

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

Remove a bank list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find brands

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering brands

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a brand

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the brand

local_name
string

Localized name of the brand

disabled
boolean

Whether the brand is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a brand by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a brand

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the brand

local_name
string

Localized name of the brand

disabled
boolean

Whether the brand is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the brand

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a brand

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find categories

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering categories

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a category

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the category

company_namespace
Array of strings

Company namespaces

type
string
Value: "main"

Category type

disabled
boolean

Whether the category is disabled

photo
string

Photo URL of the category

local_name
string

Localized name of the category

icon
string

Icon for the category

position
number

Position of the category

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_namespace": [
    ],
  • "type": "main",
  • "disabled": true,
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "position": 0,
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "main",
  • "name": "string",
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "disabled": true,
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a category by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "main",
  • "name": "string",
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "disabled": true,
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a category

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the category

company_namespace
Array of strings

Company namespaces

type
string
Value: "main"

Category type

disabled
boolean

Whether the category is disabled

photo
string

Photo URL of the category

local_name
string

Localized name of the category

icon
string

Icon for the category

position
number

Position of the category

object

Integration metadata

_id
string

Unique identifier for the category

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_namespace": [
    ],
  • "type": "main",
  • "disabled": true,
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "position": 0,
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "main",
  • "name": "string",
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "disabled": true,
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a category

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "main",
  • "name": "string",
  • "photo": "string",
  • "local_name": "string",
  • "icon": "string",
  • "disabled": true,
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find checks

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering checks

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a check

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID associated with the check

rep
string

Representative ID who received the check

checkNumber
required
string

Check number

amount
required
number

Check amount

bank
required
string

Bank name or ID

accountNumber
string

Account number

issueDate
string <date-time>

Date when check was issued

dueDate
required
string <date-time>

Due date of the check

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "clearedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a check by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "clearedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find clients

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering clients

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a client

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the client

local_name
string

Localized name of the client

tags
Array of strings

Tags associated with the client

cell_phone
string

Cell phone number

city
string

City

client_code
string

Client code

contact_name
string

Contact name

contact_title
string

Contact title

contacts
Array of strings

Associated contacts

country
string

Country

disabled
boolean

Whether the client is disabled

formatted_address
string

Formatted address

lat
number

Latitude coordinate

lng
number

Longitude coordinate

location_verified
boolean

Whether the location is verified

phone
string

Phone number

state
string

State

zip
string

Zip/Postal code

assigned_to
Array of strings

Representatives assigned to this client

credit_limit
number

Credit limit

tax_number
string

Tax number

sync_id
string

Sync identifier

profile_pic
string

Profile picture URL

logo
string

Logo URL

website
string

Website URL

email
string

Email address

comment
string

Comments

parent_client_id
string

Parent client ID for hierarchical relationships

target_visit
number

Target number of visits

geofencing_radius
number

Geofencing radius

price_tag
string

Price tag

status
string

Status

job_category
Array of strings

Job categories

territory
string

Territory

sv_priceList
string

Price list ID

object

Custom fields

paymentTerm
string

Payment term ID

speciality
Array of strings

Specialities

company_namespace
Array of strings

Company namespaces

channel
string

Channel ID

isChain
boolean

Whether this is a chain

chain
string

Chain ID

teams
Array of strings

Teams

payment_type
string
Enum: "cash" "credit"

Payment type

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "last_location_update": 0,
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { },
  • "integrated_client_balance": 0,
  • "invoice_balance_limit": 0,
  • "enable_invoice_balance_limit": true,
  • "enable_payment_terms_grace_period_days": true,
  • "is_simplified": true,
  • "last_login_time": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a client by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "last_location_update": 0,
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { },
  • "integrated_client_balance": 0,
  • "invoice_balance_limit": 0,
  • "enable_invoice_balance_limit": true,
  • "enable_payment_terms_grace_period_days": true,
  • "is_simplified": true,
  • "last_login_time": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a client

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the client

local_name
string

Localized name of the client

tags
Array of strings

Tags associated with the client

cell_phone
string

Cell phone number

city
string

City

client_code
string

Client code

contact_name
string

Contact name

contact_title
string

Contact title

contacts
Array of strings

Associated contacts

country
string

Country

disabled
boolean

Whether the client is disabled

formatted_address
string

Formatted address

lat
number

Latitude coordinate

lng
number

Longitude coordinate

location_verified
boolean

Whether the location is verified

phone
string

Phone number

state
string

State

zip
string

Zip/Postal code

assigned_to
Array of strings

Representatives assigned to this client

credit_limit
number

Credit limit

tax_number
string

Tax number

sync_id
string

Sync identifier

profile_pic
string

Profile picture URL

logo
string

Logo URL

website
string

Website URL

email
string

Email address

comment
string

Comments

parent_client_id
string

Parent client ID for hierarchical relationships

target_visit
number

Target number of visits

geofencing_radius
number

Geofencing radius

price_tag
string

Price tag

status
string

Status

job_category
Array of strings

Job categories

territory
string

Territory

sv_priceList
string

Price list ID

object

Custom fields

paymentTerm
string

Payment term ID

speciality
Array of strings

Specialities

company_namespace
Array of strings

Company namespaces

channel
string

Channel ID

isChain
boolean

Whether this is a chain

chain
string

Chain ID

teams
Array of strings

Teams

payment_type
string
Enum: "cash" "credit"

Payment type

object

Integration metadata

_id
string

Unique identifier for the client

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "last_location_update": 0,
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { },
  • "integrated_client_balance": 0,
  • "invoice_balance_limit": 0,
  • "enable_invoice_balance_limit": true,
  • "enable_payment_terms_grace_period_days": true,
  • "is_simplified": true,
  • "last_login_time": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a client

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "tags": [
    ],
  • "cell_phone": "string",
  • "city": "string",
  • "client_code": "string",
  • "contact_name": "string",
  • "contact_title": "string",
  • "contacts": [
    ],
  • "country": "string",
  • "disabled": true,
  • "formatted_address": "string",
  • "lat": 0,
  • "lng": 0,
  • "location_verified": true,
  • "phone": "string",
  • "state": "string",
  • "zip": "string",
  • "assigned_to": [
    ],
  • "last_location_update": 0,
  • "credit_limit": 0,
  • "tax_number": "string",
  • "sync_id": "string",
  • "profile_pic": "string",
  • "logo": "string",
  • "website": "string",
  • "email": "string",
  • "comment": "string",
  • "parent_client_id": "string",
  • "target_visit": 0,
  • "geofencing_radius": 0,
  • "price_tag": "string",
  • "status": "string",
  • "job_category": [
    ],
  • "territory": "string",
  • "sv_priceList": "string",
  • "customFields": { },
  • "paymentTerm": "string",
  • "speciality": [
    ],
  • "company_namespace": [
    ],
  • "channel": "string",
  • "isChain": true,
  • "chain": "string",
  • "teams": [
    ],
  • "payment_type": "cash",
  • "integration_meta": { },
  • "integrated_client_balance": 0,
  • "invoice_balance_limit": 0,
  • "enable_invoice_balance_limit": true,
  • "enable_payment_terms_grace_period_days": true,
  • "is_simplified": true,
  • "last_login_time": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find contracts

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering contracts

Responses

Response samples

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

Create a contract

Authorizations:
ApiKeyAuth
Request Body schema: application/json
title
string
client
string
startDate
string <date-time>
endDate
string <date-time>
totalAmount
number
currency
string
status
string
terms
string
installments
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "client": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "currency": "string",
  • "status": "string",
  • "terms": "string",
  • "installments": [
    ]
}

Response samples

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

Get a contract by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a contract

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
title
string
client
string
startDate
string <date-time>
endDate
string <date-time>
totalAmount
number
currency
string
status
string
terms
string
installments
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "client": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "currency": "string",
  • "status": "string",
  • "terms": "string",
  • "installments": [
    ]
}

Response samples

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

Remove a contract

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find custom list items

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering custom list items

Responses

Response samples

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

Create a custom list item

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
value
string
customList
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "customList": "string",
  • "disabled": true
}

Response samples

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

Get a custom list item by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a custom list item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
value
string
customList
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "customList": "string",
  • "disabled": true
}

Response samples

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

Remove a custom list item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find custom lists

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering custom lists

Responses

Response samples

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

Create a custom list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
description
string
entity
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "entity": "string",
  • "disabled": true
}

Response samples

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

Get a custom list by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a custom list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
description
string
entity
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "entity": "string",
  • "disabled": true
}

Response samples

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

Remove a custom list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find custom statuses

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering custom statuses

Responses

Response samples

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

Create a custom status

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
color
string
entity
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string",
  • "entity": "string",
  • "disabled": true
}

Response samples

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

Get a custom status by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a custom status

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
color
string
entity
string
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "string",
  • "entity": "string",
  • "disabled": true
}

Response samples

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

Remove a custom status

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find days

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering days

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a day

Authorizations:
ApiKeyAuth
Request Body schema: application/json
rep
required
string

Representative ID

date
required
string <date>

Date of the working day

startTime
string <time>

Start time of the day

notes
string

Additional notes for the day

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "rep": "string",
  • "date": "2019-08-24",
  • "startTime": "14:15:22Z",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "rep": "string",
  • "date": "2019-08-24",
  • "startTime": "14:15:22Z",
  • "endTime": "14:15:22Z",
  • "status": "open",
  • "visits": [
    ],
  • "orders": [
    ],
  • "activities": [
    ],
  • "summary": {
    },
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a day by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "rep": "string",
  • "date": "2019-08-24",
  • "startTime": "14:15:22Z",
  • "endTime": "14:15:22Z",
  • "status": "open",
  • "visits": [
    ],
  • "orders": [
    ],
  • "activities": [
    ],
  • "summary": {
    },
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find full invoices

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering full invoices

Responses

Response samples

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

Create a full invoice

Authorizations:
ApiKeyAuth
Request Body schema: application/json
serial
string
client
string
rep
string
warehouse
string
items
Array of objects
total
number
status
string
dueDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "serial": "string",
  • "client": "string",
  • "rep": "string",
  • "warehouse": "string",
  • "items": [
    ],
  • "total": 0,
  • "status": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

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

Get a full invoice by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a full invoice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
serial
string
client
string
rep
string
warehouse
string
items
Array of objects
total
number
status
string
dueDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "serial": "string",
  • "client": "string",
  • "rep": "string",
  • "warehouse": "string",
  • "items": [
    ],
  • "total": 0,
  • "status": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

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

Find integration apps

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering integration apps

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create an integration app

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the integration app

description
string

Description of the integration app

available_app
required
string

Available app reference

company_namespace
required
string

Company namespace

object

Configuration settings for the integration

object

Credentials for the integration

object

API endpoints configuration

object

Webhook configuration

object

Synchronization settings

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "available_app": "string",
  • "company_namespace": "string",
  • "config": { },
  • "credentials": { },
  • "endpoints": { },
  • "webhooks": { },
  • "sync_settings": { },
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "version": "string",
  • "status": "active",
  • "available_app": "string",
  • "company_namespace": "string",
  • "config": { },
  • "credentials": { },
  • "endpoints": { },
  • "webhooks": { },
  • "sync_settings": { },
  • "last_sync": "2019-08-24T14:15:22Z",
  • "error_count": 0,
  • "success_count": 0,
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get an integration app by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "version": "string",
  • "status": "active",
  • "available_app": "string",
  • "company_namespace": "string",
  • "config": { },
  • "credentials": { },
  • "endpoints": { },
  • "webhooks": { },
  • "sync_settings": { },
  • "last_sync": "2019-08-24T14:15:22Z",
  • "error_count": 0,
  • "success_count": 0,
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update an integration app

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the integration app

description
string

Description of the integration app

status
string
Enum: "active" "inactive" "pending"

Status of the integration app

object

Configuration settings for the integration

object

Credentials for the integration

object

API endpoints configuration

object

Webhook configuration

object

Synchronization settings

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "status": "active",
  • "config": { },
  • "credentials": { },
  • "endpoints": { },
  • "webhooks": { },
  • "sync_settings": { },
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "version": "string",
  • "status": "active",
  • "available_app": "string",
  • "company_namespace": "string",
  • "config": { },
  • "credentials": { },
  • "endpoints": { },
  • "webhooks": { },
  • "sync_settings": { },
  • "last_sync": "2019-08-24T14:15:22Z",
  • "error_count": 0,
  • "success_count": 0,
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find inventory adjustment reasons

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering inventory adjustment reasons

Responses

Response samples

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

Create an inventory adjustment reason

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
type
string
Enum: "increase" "decrease"
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "increase",
  • "disabled": true
}

Response samples

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

Get an inventory adjustment reason by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an inventory adjustment reason

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
type
string
Enum: "increase" "decrease"
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "increase",
  • "disabled": true
}

Response samples

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

Remove an inventory adjustment reason

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find inventory items

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering inventory items

Responses

Response samples

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

Find measure unit families

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering measure unit families

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a measure unit family

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the measure unit family

local_name
string

Localized name of the measure unit family

measureunits
Array of strings

IDs of measure units in this family

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the measure unit family is disabled

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "company_namespace": [
    ],
  • "disabled": true,
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a measure unit family by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a measure unit family

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the measure unit family

local_name
string

Localized name of the measure unit family

measureunits
Array of strings

IDs of measure units in this family

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the measure unit family is disabled

object

Integration metadata

_id
string

Unique identifier for the measure unit family

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "company_namespace": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a measure unit family

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "measureunits": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find measure units

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering measure units

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a measure unit

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the measure unit

factor
required
number

Factor of the measure unit

local_name
string

Localized name of the measure unit

parent
string

Parent measure unit ID

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the measure unit is disabled

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "company_namespace": [
    ],
  • "disabled": true,
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a measure unit by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a measure unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the measure unit

factor
number

Factor of the measure unit

local_name
string

Localized name of the measure unit

parent
string

Parent measure unit ID

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the measure unit is disabled

object

Integration metadata

_id
string

Unique identifier for the measure unit

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "company_namespace": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a measure unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "factor": 0,
  • "local_name": "string",
  • "parent": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find media storage items

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering media storage items

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a media storage item

Authorizations:
ApiKeyAuth
Request Body schema: application/json
filename
required
string

Original filename

url
required
string

URL to access the media file

mimeType
required
string

MIME type of the file

size
required
number

File size in bytes

category
string

Media category

entityType
string

Type of entity this media is associated with

entityId
string

ID of the entity this media is associated with

isPublic
boolean

Whether the media is publicly accessible

thumbnailUrl
string

URL to thumbnail version (for images)

object

Additional metadata about the file

tags
Array of strings

Tags associated with the media

description
string

Description of the media

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a media storage item by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a media storage item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
filename
string

Original filename

category
string

Media category

entityType
string

Type of entity this media is associated with

entityId
string

ID of the entity this media is associated with

isPublic
boolean

Whether the media is publicly accessible

object

Additional metadata about the file

tags
Array of strings

Tags associated with the media

description
string

Description of the media

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "isPublic": true,
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a media storage item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find media

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering media

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create media

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the media

description
string

Description of the media

url
required
string

URL of the media

document_type
required
string
Enum: "html" "csv" "json" "image" "pdf" "ppt" "pptx" "xls" "xlsx" "doc" "docx" "images" "zip" "pt"

Type of media document

parent_document_type
string
Enum: "clients" "asset" "assetUnit" "workorder" "clientLocation" "clientContact" "commentsThread" "workorderRequest" "workorderPortal" "invoice" "products" "productvariations" "representatives" "productcategories" "productSubCategory" "speciality" "line" "banner" "intgAvailableApps"

Type of parent document

parent_document_key
string

Key of parent document

disabled
boolean

Whether the media is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get media by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update media

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the media

description
string

Description of the media

url
string

URL of the media

document_type
string
Enum: "html" "csv" "json" "image" "pdf" "ppt" "pptx" "xls" "xlsx" "doc" "docx" "images" "zip" "pt"

Type of media document

parent_document_type
string
Enum: "clients" "asset" "assetUnit" "workorder" "clientLocation" "clientContact" "commentsThread" "workorderRequest" "workorderPortal" "invoice" "products" "productvariations" "representatives" "productcategories" "productSubCategory" "speciality" "line" "banner" "intgAvailableApps"

Type of parent document

parent_document_key
string

Key of parent document

disabled
boolean

Whether the media is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the media

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove media

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find MSL products

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering MSL products

Responses

Response samples

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

Create an MSL product

Authorizations:
ApiKeyAuth
Request Body schema: application/json
msl
string
product
string
variant
string
targetQuantity
number
achievedQuantity
number
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "msl": "string",
  • "product": "string",
  • "variant": "string",
  • "targetQuantity": 0,
  • "achievedQuantity": 0,
  • "disabled": true
}

Response samples

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

Get an MSL product by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an MSL product

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
msl
string
product
string
variant
string
targetQuantity
number
achievedQuantity
number
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "msl": "string",
  • "product": "string",
  • "variant": "string",
  • "targetQuantity": 0,
  • "achievedQuantity": 0,
  • "disabled": true
}

Response samples

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

Remove an MSL product

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find MSLs

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering MSLs

Responses

Response samples

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

Create an MSL

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
client
string
rep
string
startDate
string <date-time>
endDate
string <date-time>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "client": "string",
  • "rep": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Response samples

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

Get an MSL by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update an MSL

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
client
string
rep
string
startDate
string <date-time>
endDate
string <date-time>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "client": "string",
  • "rep": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Response samples

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

Remove an MSL

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find payment terms

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering payment terms

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ],
  • "pagination": {
    }
}

Create a payment term

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the payment term

description
string

Description of the payment term

days
integer

Number of days for payment

discount_percentage
number <float>

Discount percentage if paid early

discount_days
integer

Number of days for discount eligibility

is_active
boolean
Default: true

Whether the payment term is active

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "days": 0,
  • "discount_percentage": 0,
  • "discount_days": 0,
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Get a payment term by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a payment term

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the payment term

description
string

Description of the payment term

days
integer

Number of days for payment

discount_percentage
number <float>

Discount percentage if paid early

discount_days
integer

Number of days for discount eligibility

is_active
boolean

Whether the payment term is active

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "days": 0,
  • "discount_percentage": 0,
  • "discount_days": 0,
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Remove a payment term

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": { }
}

Find payments

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering payments

Responses

Response samples

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

Create a payment

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
string
rep
string
amount
number
paymentMethod
string
reference
string
description
string
date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "amount": 0,
  • "paymentMethod": "string",
  • "reference": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

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

Get a payment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a payment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
client
string
rep
string
amount
number
paymentMethod
string
reference
string
description
string
date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "amount": 0,
  • "paymentMethod": "string",
  • "reference": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z"
}

Response samples

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

Find price list items

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering price list items

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a price list item

Authorizations:
ApiKeyAuth
Request Body schema: application/json
product_id
required
string

ID of the product

variant_id
required
string

ID of the variant

pricelist_id
required
string

ID of the price list

price
required
number

Price value

object

Integration metadata

disabled
boolean

Whether the price list item is disabled

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "integration_meta": { },
  • "disabled": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a price list item by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a price list item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
product_id
string

ID of the product

variant_id
string

ID of the variant

pricelist_id
string

ID of the price list

price
number

Price value

object

Integration metadata

disabled
boolean

Whether the price list item is disabled

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the price list item

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "integration_meta": { },
  • "disabled": true,
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a price list item

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "product_id": "string",
  • "variant_id": "string",
  • "pricelist_id": "string",
  • "price": 0,
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find price lists

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering price lists

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a price list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the price list

object

Integration metadata

disabled
boolean

Whether the price list is disabled

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "integration_meta": { },
  • "disabled": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "createdby": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a price list by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "createdby": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a price list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the price list

object

Integration metadata

disabled
boolean

Whether the price list is disabled

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the price list

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "integration_meta": { },
  • "disabled": true,
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "createdby": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a price list

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "createdby": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find product groups

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering product groups

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a product group

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the product group

local_name
string

Localized name of the product group

disabled
boolean

Whether the product group is disabled

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a product group by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a product group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the product group

local_name
string

Localized name of the product group

disabled
boolean

Whether the product group is disabled

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the product group

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a product group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find products

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering products

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a product

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the product

category
required
string

ID of the product category

active
boolean

Whether the product is active

company_namespace
Array of strings

Company namespaces

local_name
string

Localized name of the product

sku
string

Stock keeping unit

sub_category
Array of strings

IDs of the product sub-categories

assigned_to
Array of strings

Representatives assigned to this product

auditable
boolean

Whether the product is auditable

barcode
string

Barcode of the product

sv_tax
string

ID of the tax

sv_measureUnit
string

ID of the measure unit

description
string

Description of the product

local_description
string

Localized description of the product

product_img
string

Product image URL

base_price
string

Base price of the product

assigned_media
Array of strings

Media assigned to this product

html_description
string

HTML description of the product

modifiers_group
Array of strings

Modifier groups for the product

featured
boolean

Whether the product is featured

brand
string

ID of the brand

rsp
number

Recommended selling price

measureunit_family
string

ID of the measure unit family

object

Integration metadata

teams
Array of strings

Teams

position
number

Position of the product

product_groups
Array of strings

Product groups

frozen_pre_sales
boolean

Whether pre-sales are frozen

frozen_sales
boolean

Whether sales are frozen

Array of objects (VariantCreateBody)

List of variants for this product

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a product by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a product

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the product

category
string

ID of the product category

active
boolean

Whether the product is active

company_namespace
Array of strings

Company namespaces

local_name
string

Localized name of the product

sku
string

Stock keeping unit

sub_category
Array of strings

IDs of the product sub-categories

assigned_to
Array of strings

Representatives assigned to this product

auditable
boolean

Whether the product is auditable

barcode
string

Barcode of the product

sv_tax
string

ID of the tax

sv_measureUnit
string

ID of the measure unit

description
string

Description of the product

local_description
string

Localized description of the product

product_img
string

Product image URL

base_price
string

Base price of the product

assigned_media
Array of strings

Media assigned to this product

html_description
string

HTML description of the product

modifiers_group
Array of strings

Modifier groups for the product

featured
boolean

Whether the product is featured

brand
string

ID of the brand

rsp
number

Recommended selling price

measureunit_family
string

ID of the measure unit family

object

Integration metadata

teams
Array of strings

Teams

position
number

Position of the product

product_groups
Array of strings

Product groups

frozen_pre_sales
boolean

Whether pre-sales are frozen

frozen_sales
boolean

Whether sales are frozen

_id
string

Unique identifier for the product

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Array of objects

List of variants for this product

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0,
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a product

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "category": "string",
  • "active": true,
  • "company_namespace": [
    ],
  • "local_name": "string",
  • "sku": "string",
  • "sub_category": [
    ],
  • "assigned_to": [
    ],
  • "auditable": true,
  • "barcode": "string",
  • "sv_tax": "string",
  • "sv_measureUnit": "string",
  • "description": "string",
  • "local_description": "string",
  • "product_img": "string",
  • "base_price": "string",
  • "assigned_media": [
    ],
  • "html_description": "string",
  • "modifiers_group": [
    ],
  • "featured": true,
  • "brand": "string",
  • "rsp": 0,
  • "measureunit_family": "string",
  • "integration_meta": { },
  • "teams": [
    ],
  • "position": 0,
  • "product_groups": [
    ],
  • "frozen_pre_sales": true,
  • "frozen_sales": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find proformas

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering proformas

Responses

Response samples

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

Create a proforma

Authorizations:
ApiKeyAuth
Request Body schema: application/json
serial
string
client
string
rep
string
warehouse
string
items
Array of objects
total
number
status
string
validUntil
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "serial": "string",
  • "client": "string",
  • "rep": "string",
  • "warehouse": "string",
  • "items": [
    ],
  • "total": 0,
  • "status": "string",
  • "validUntil": "2019-08-24T14:15:22Z"
}

Response samples

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

Get a proforma by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a proforma

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
serial
string
client
string
rep
string
warehouse
string
items
Array of objects
total
number
status
string
validUntil
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "serial": "string",
  • "client": "string",
  • "rep": "string",
  • "warehouse": "string",
  • "items": [
    ],
  • "total": 0,
  • "status": "string",
  • "validUntil": "2019-08-24T14:15:22Z"
}

Response samples

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

Convert document to PDF

Authorizations:
ApiKeyAuth
Request Body schema: application/json
documentType
required
string
Enum: "invoice" "proforma" "order" "quote" "receipt"

Type of document to convert

documentId
required
string

ID of the document to convert

template
string

Template to use for PDF generation

object

PDF generation options

language
string

Language for the PDF content

Responses

Request samples

Content type
application/json
{
  • "documentType": "invoice",
  • "documentId": "string",
  • "template": "string",
  • "options": {
    },
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "pdfUrl": "string",
  • "filename": "string",
  • "size": 0,
  • "pages": 0,
  • "generatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Find receiving materials

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering receiving materials

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a receiving material

Authorizations:
ApiKeyAuth
Request Body schema: application/json
warehouse
required
string

Warehouse ID where materials are received

supplier
required
string

Supplier ID providing the materials

rep
string

Representative ID who received the materials

receiptNumber
string

Receipt number

receiptDate
string <date-time>

Date when materials were received

required
Array of objects

List of items received

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "warehouse": "string",
  • "supplier": "string",
  • "rep": "string",
  • "receiptNumber": "string",
  • "receiptDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "warehouse": "string",
  • "supplier": "string",
  • "rep": "string",
  • "receiptNumber": "string",
  • "receiptDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a receiving material by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "warehouse": "string",
  • "supplier": "string",
  • "rep": "string",
  • "receiptNumber": "string",
  • "receiptDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a receiving material

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
receiptDate
string <date-time>

Date when materials were received

Array of objects

List of items received

status
string
Enum: "pending" "received" "cancelled"

Status of the receiving material

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "receiptDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "status": "pending",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "warehouse": "string",
  • "supplier": "string",
  • "rep": "string",
  • "receiptNumber": "string",
  • "receiptDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find refunds

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering refunds

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a refund

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID associated with the refund

rep
string

Representative ID who processed the refund

invoice
string

Invoice ID being refunded

amount
required
number

Refund amount

reason
required
string

Reason for the refund

refundMethod
string

Method of refund

reference
string

Reference number for the refund

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a refund by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a refund

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
status
string
Enum: "pending" "approved" "rejected" "processed"

Status of the refund

refundMethod
string

Method of refund

reference
string

Reference number for the refund

notes
string

Additional notes

processedAt
string <date-time>

When the refund was processed

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find rep balance summaries

Authorizations:
ApiKeyAuth
query Parameters
rep
required
string

The rep ID to get balance summary for

page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 20

Number of items per page

disabled
boolean
Default: false

Whether to include disabled records

populatedKeys
Array of strings

Keys to populate in the response

Responses

Response samples

Content type
application/json
{
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string",
  • "data": [
    ],
  • "totals": {
    },
  • "options": {
    }
}

Find reps

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering reps

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a rep

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the rep

email
required
string

Email of the rep

username
string

Username of the rep

phone
string

Phone number of the rep

role
required
string

Role of the rep

team_id
string

ID of the team the rep belongs to

password
required
string

Password for the rep account

disabled
boolean

Whether the rep is disabled

object

Rep permissions

object

Rep settings

object

Integration metadata

company_namespace
required
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a rep by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a rep

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the rep

email
string

Email of the rep

username
string

Username of the rep

phone
string

Phone number of the rep

role
string

Role of the rep

team_id
string

ID of the team the rep belongs to

password
string

Password for the rep account

disabled
boolean

Whether the rep is disabled

object

Rep permissions

object

Rep settings

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the rep

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a rep

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "email": "string",
  • "username": "string",
  • "phone": "string",
  • "role": "string",
  • "team_id": "string",
  • "password": "string",
  • "disabled": true,
  • "permissions": {
    },
  • "settings": {
    },
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find return reasons

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering return reasons

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a return reason

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the return reason

local_name
string

Localized name of the return reason

disabled
boolean

Whether the return reason is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a return reason by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a return reason

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the return reason

local_name
string

Localized name of the return reason

disabled
boolean

Whether the return reason is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the return reason

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a return reason

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "local_name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find routes

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering routes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a route

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the route

rep_id
required
string

ID of the assigned rep

day
required
string
Enum: "sat" "sun" "mon" "tue" "wed" "thu" "fri"

Day of the week for the route

Array of objects

List of clients on this route

disabled
boolean

Whether the route is disabled

object

Integration metadata

company_namespace
required
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a route by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a route

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the route

rep_id
string

ID of the assigned rep

day
string
Enum: "sat" "sun" "mon" "tue" "wed" "thu" "fri"

Day of the week for the route

Array of objects

List of clients on this route

disabled
boolean

Whether the route is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the route

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a route

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find settings

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering settings

Responses

Response samples

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

Get settings by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update settings

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
key
string
string or number or boolean or object
category
string
description
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "category": "string",
  • "description": "string"
}

Response samples

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

Find settlements

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering settlements

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a settlement

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID associated with the settlement

rep
string

Representative ID who processed the settlement

required
Array of objects

List of invoices included in settlement

required
Array of objects

List of payments included in settlement

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "settlementDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a settlement by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "settlementDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find storecheck templates

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering storecheck templates

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a storecheck template

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the storecheck template

description
string

Description of the template

category
string

Category of the storecheck

required
Array of objects

Template sections and questions

targets
Array of strings

Target entities (clients, routes, etc.)

frequency
string
Enum: "daily" "weekly" "monthly" "quarterly" "yearly" "custom"

Frequency of storecheck execution

validFrom
string <date-time>

Start date of template validity

validTo
string <date-time>

End date of template validity

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a storecheck template by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a storecheck template

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the storecheck template

description
string

Description of the template

category
string

Category of the storecheck

Array of objects

Template sections and questions

targets
Array of strings

Target entities (clients, routes, etc.)

frequency
string
Enum: "daily" "weekly" "monthly" "quarterly" "yearly" "custom"

Frequency of storecheck execution

validFrom
string <date-time>

Start date of template validity

validTo
string <date-time>

End date of template validity

disabled
boolean

Whether the template is disabled

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "disabled": true,
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a storecheck template

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "sections": [
    ],
  • "targets": [
    ],
  • "frequency": "daily",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find subcategories

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering subcategories

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a subcategory

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the subcategory

parent_id
required
string

ID of the parent category

local_name
string

Localized name of the subcategory

disabled
boolean

Whether the subcategory is disabled

photo
string

Photo URL of the subcategory

position
number

Position of the subcategory

company_namespace
Array of strings

Company namespaces

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "company_namespace": [
    ],
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a subcategory by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
object

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a subcategory

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the subcategory

parent_id
string

ID of the parent category

local_name
string

Localized name of the subcategory

disabled
boolean

Whether the subcategory is disabled

photo
string

Photo URL of the subcategory

position
number

Position of the subcategory

company_namespace
Array of strings

Company namespaces

object

Integration metadata

_id
string

Unique identifier for the subcategory

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "company_namespace": [
    ],
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a subcategory

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "parent_id": "string",
  • "local_name": "string",
  • "disabled": true,
  • "photo": "string",
  • "position": 0,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find suppliers

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering suppliers

Responses

Response samples

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

Create a supplier

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
email
string <email>
phone
string
address
object
integration_meta
object
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "address": { },
  • "integration_meta": { },
  • "disabled": true
}

Response samples

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

Get a supplier by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a supplier

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string
email
string <email>
phone
string
address
object
integration_meta
object
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "address": { },
  • "integration_meta": { },
  • "disabled": true
}

Response samples

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

Remove a supplier

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find tags

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering tags

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a tag

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the tag

disabled
boolean

Whether the tag is disabled

object

Integration metadata

company_namespace
required
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a tag by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a tag

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the tag

disabled
boolean

Whether the tag is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the tag

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a tag

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find taxes

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering taxes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a tax

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the tax

rate
required
number

Tax rate

type
required
string
Enum: "inclusive" "additive" "N/A"

Type of tax

disabled
boolean

Whether the tax is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a tax by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a tax

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the tax

rate
number

Tax rate

type
string
Enum: "inclusive" "additive" "N/A"

Type of tax

disabled
boolean

Whether the tax is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the tax

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a tax

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find teams

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering teams

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a team

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the team

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the team is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a team by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0,
  • "admins": null,
  • "reps": null
}

Update a team

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the team

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the team is disabled

_id
string

Unique identifier for the team

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_namespace": [
    ],
  • "disabled": true,
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a team

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "disabled": true,
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find transfers

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering transfers

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a transfer

Authorizations:
ApiKeyAuth
Request Body schema: application/json
fromWarehouse
required
string

Source warehouse ID

toWarehouse
required
string

Destination warehouse ID

rep
string

Representative ID who initiated the transfer

expectedDate
string <date-time>

Expected delivery date

required
Array of objects

List of items being transferred

reason
string

Reason for the transfer

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a transfer by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a transfer

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
expectedDate
string <date-time>

Expected delivery date

status
string
Enum: "pending" "in_transit" "completed" "cancelled"

Status of the transfer

Array of objects

List of items being transferred

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find variants

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering variants

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a variant

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the variant

product
required
string

ID of the product this variant belongs to

price
required
number

Price of the variant

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the variant is disabled

uuid
string

UUID for the variant

local_name
string

Localized name of the variant

sku
string

Stock keeping unit

barcode
string

Barcode of the variant

weight
number

Weight of the variant

length
number

Length of the variant

width
number

Width of the variant

height
number

Height of the variant

position
number

Position of the variant

default
boolean

Whether this is the default variant

variant_img
string

Image URL for the variant

modifiers_groups
Array of strings

Modifier groups for the variant

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "$ref": null
}

Get a variant by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a variant

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the variant

product
string

ID of the product this variant belongs to

price
number

Price of the variant

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the variant is disabled

uuid
string

UUID for the variant

local_name
string

Localized name of the variant

sku
string

Stock keeping unit

barcode
string

Barcode of the variant

weight
number

Weight of the variant

length
number

Length of the variant

width
number

Width of the variant

height
number

Height of the variant

position
number

Position of the variant

default
boolean

Whether this is the default variant

variant_img
string

Image URL for the variant

modifiers_groups
Array of strings

Modifier groups for the variant

object

Integration metadata

_id
string

Unique identifier for the variant

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a variant

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find visits

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering visits

Responses

Response samples

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

Create a visit

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
string
rep
string
plannedDate
string <date-time>
actualDate
string <date-time>
status
string
Enum: "planned" "completed" "cancelled"
notes
string
location
object

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "plannedDate": "2019-08-24T14:15:22Z",
  • "actualDate": "2019-08-24T14:15:22Z",
  • "status": "planned",
  • "notes": "string",
  • "location": { }
}

Response samples

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

Get a visit by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a visit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
client
string
rep
string
plannedDate
string <date-time>
actualDate
string <date-time>
status
string
Enum: "planned" "completed" "cancelled"
notes
string
location
object

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "plannedDate": "2019-08-24T14:15:22Z",
  • "actualDate": "2019-08-24T14:15:22Z",
  • "status": "planned",
  • "notes": "string",
  • "location": { }
}

Response samples

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

Find warehouses

Authorizations:
ApiKeyAuth
query Parameters
object

Query parameters for filtering warehouses

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a warehouse

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the warehouse

object

Geographic location of the warehouse

disabled
boolean

Whether the warehouse is disabled

object

Integration metadata

company_namespace
required
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a warehouse by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a warehouse

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the warehouse

object

Geographic location of the warehouse

disabled
boolean

Whether the warehouse is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the warehouse

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a warehouse

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "location": {
    },
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Find workorder requests

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering workorder requests

Responses

Response samples

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

Create a workorder request

Authorizations:
ApiKeyAuth
Request Body schema: application/json
title
string
description
string
priority
string
Enum: "low" "medium" "high" "urgent"
requestedBy
string
client
string
asset
string
category
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "priority": "low",
  • "requestedBy": "string",
  • "client": "string",
  • "asset": "string",
  • "category": "string"
}

Response samples

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

Get a workorder request by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a workorder request

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
title
string
description
string
priority
string
Enum: "low" "medium" "high" "urgent"
requestedBy
string
client
string
asset
string
category
string
status
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "priority": "low",
  • "requestedBy": "string",
  • "client": "string",
  • "asset": "string",
  • "category": "string",
  • "status": "string"
}

Response samples

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

Remove a workorder request

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Find workorders

Authorizations:
ApiKeyAuth
query Parameters
params
object

Query parameters for filtering workorders

Responses

Response samples

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

Create a workorder

Authorizations:
ApiKeyAuth
Request Body schema: application/json
title
string
description
string
priority
string
Enum: "low" "medium" "high" "urgent"
status
string
assignedTo
string
client
string
asset
string
category
string
dueDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "priority": "low",
  • "status": "string",
  • "assignedTo": "string",
  • "client": "string",
  • "asset": "string",
  • "category": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

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

Get a workorder by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Update a workorder

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
title
string
description
string
priority
string
Enum: "low" "medium" "high" "urgent"
status
string
assignedTo
string
client
string
asset
string
category
string
dueDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "priority": "low",
  • "status": "string",
  • "assignedTo": "string",
  • "client": "string",
  • "asset": "string",
  • "category": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

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

Remove a workorder

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}