API reference

Velosity API

Operations, parameters, and response codes generated from the current OpenAPI contract.

OpenAPI v1 · refreshed at most every 10 minutes · Download specification

AccountCustomers

GET /v1/customer/accounts/{UserID} #

Parameters

Name	In	Type	Required	Details	Description
`UserID`	path	`string`	Yes

Responses

200 OK

GET /v1/customer/accounts/byemail/{EmailAddress} #

Parameters

Name	In	Type	Required	Details	Description
`EmailAddress`	path	`string`	Yes

Responses

200 OK

GET /v1/customer/accounts/bymobilenumber/{MobileNumber} #

Parameters

Name	In	Type	Required	Details	Description
`MobileNumber`	path	`string`	Yes

Responses

200 OK

AccountsLite

GET /v1/accounts/lite #

Parameters

Name	In	Type	Required	Details	Description
`IsActive`	query	`string`	No	default: *

Responses

200 OK

GET /v1/accounts/lite/{UserID} #

Parameters

Name	In	Type	Required	Details	Description
`UserID`	path	`string`	Yes

Responses

200 OK

Announcements

POST /v1/announcements #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AnnouncementModel ProblemDetails

GET /v1/announcements/{AnnouncementID} #

Parameters

Name	In	Type	Required	Details	Description
`AnnouncementID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/announcements/active #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ApprovalPolicies

GET /v1/approval/policies #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/approval/policies #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ApprovalPolicyModel ProblemDetails

DELETE /v1/approval/policies/{PolicyID} #

Parameters

Name	In	Type	Required	Details	Description
`PolicyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/approval/policies/{PolicyID} #

Parameters

Name	In	Type	Required	Details	Description
`PolicyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/approval/policies/{PolicyID} #

Parameters

Name	In	Type	Required	Details	Description
`PolicyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ApprovalPolicyModel ProblemDetails

Attributes

POST /v1/{ProductID}/attributes/{AttributeID}/requestvalue #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/attributes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionAttributeModel ProblemDetails

DELETE /v1/attributes/{AttributeID} #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/{AttributeID} #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/attributes/{AttributeID} #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionAttributeModel ProblemDetails

POST /v1/attributes/{AttributeID}/queries/test #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QueryTestModel

PATCH /v1/attributes/{AttributeID}/query #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionAttributeModel ProblemDetails

GET /v1/attributes/{AttributeID}/revisions/history #

Parameters

Name	In	Type	Required	Details	Description
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/{ProductID}/export #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/attributes/batch #

Responses

200 OK

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionAttributeModel ProblemDetails

PUT /v1/attributes/batch #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionAttributeModel ProblemDetails

POST /v1/attributes/by/productids #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/search/{number} #

Parameters

Name	In	Type	Required	Details	Description
`number`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/attributes #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/attributes/count #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/attributes/export #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Audit

GET /v1/audit #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/audit #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AuditModel ProblemDetails

GET /v1/audit/{AuditID} #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/audit/byid/{EntityID} #

Parameters

Name	In	Type	Required	Details	Description
`EntityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/audit/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AuditSlicerModel ProblemDetails

POST /v1/audit/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AuditSlicerModel ProblemDetails

POST /v1/audit/prodorders/phase #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderAuditSlicerModel

POST /v1/audit/prodorders/status #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderAuditSlicerModel

POST /v1/audit/salesorders/status #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOrderAuditSlicerModel

POST /v1/audit/salesquotes/phase #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteAuditSlicerModel

POST /v1/audit/salesquotes/status #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteAuditSlicerModel

AutomationDesign

GET /v1/automation/designs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/automation/designs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationDesignModel ProblemDetails

DELETE /v1/automation/designs/{DesignID} #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/designs/{DesignID} #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/automation/designs/{DesignID} #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationDesignModel ProblemDetails

AutomationDesignRules

GET /v1/automation/designs/{DesignID}/rules #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/automation/designs/{DesignID}/rules #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationDesignRuleModel ProblemDetails

DELETE /v1/automation/designs/{DesignID}/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`RuleID`	path	`string`	Yes
`DesignID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/designs/{DesignID}/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes
`RuleID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/automation/designs/{DesignID}/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`DesignID`	path	`string`	Yes
`RuleID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationDesignRuleModel ProblemDetails

AutomationRun

GET /v1/automation/runs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/automation/runs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationRunModel ProblemDetails

DELETE /v1/automation/runs/{RunID} #

Parameters

Name	In	Type	Required	Details	Description
`RunID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/runs/{RunID} #

Parameters

Name	In	Type	Required	Details	Description
`RunID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/automation/runs/{RunID} #

Parameters

Name	In	Type	Required	Details	Description
`RunID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: AutomationRunModel ProblemDetails

GET /v1/automation/runs/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/runs/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/runs/process #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/automation/runs/search/{searchfor} #

Parameters

Name	In	Type	Required	Details	Description
`searchfor`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Configure

POST /v1/configure/{ProductID}/configuration #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ConfigurationModel ProblemDetails

PUT /v1/configure/{ProductID}/promotion/create #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ConfigurationModel ProblemDetails

GET /v1/configure/{ProductID}/reset #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/configure/{ProductID}/salesorders/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SalesOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ConfigurationModel ProblemDetails

PUT /v1/configure/{ProductID}/salesquotes/{SalesQuoteID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ConfigurationModel ProblemDetails

GET /v1/configure/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Countries

GET /v1/setup/countries #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/countries/{CountryID} #

Parameters

Name	In	Type	Required	Details	Description
`CountryID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/countries/codes/{code} #

Parameters

Name	In	Type	Required	Details	Description
`code`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Currencies

GET /v1/setup/currencies #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/currencies/{CurrencyID} #

Parameters

Name	In	Type	Required	Details	Description
`CurrencyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/currencies/codes/{code} #

Parameters

Name	In	Type	Required	Details	Description
`code`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

CurrenciesFx

GET /v1/setup/currencies/{CurrencyID}/fx #

Parameters

Name	In	Type	Required	Details	Description
`CurrencyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/currencies/codes/{code}/fx #

Parameters

Name	In	Type	Required	Details	Description
`code`	path	`string`	Yes
`date`	query	`string`	No	format: date-time

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/currencies/fx #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

CustomerMetrics

DELETE /v1/customers/{CustomerID}/metrics #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/{CustomerID}/metrics #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/customers/{CustomerID}/metrics #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerMetricsModel

GET /v1/customers/metrics #

Responses

200 OK

CustomerOrders

GET /v1/customerorders #

Responses

200 OK

PUT /v1/customerorders #

Responses

200 OK

Schemas: CustomerOrderModel

DELETE /v1/customerorders/{CustomerOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerOrderID`	path	`string`	Yes

Responses

200 OK

GET /v1/customerorders/{CustomerOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerOrderID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/customerorders/{CustomerOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerOrderModel

PUT /v1/customerorders/{CustomerOrderID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`CustomerOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: NoteModel

GET /v1/customerorders/bysalesorder/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

200 OK

GET /v1/customerorders/count #

Responses

200 OK

GET /v1/customerorders/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1
`recordsperpage`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

GET /v1/customerorders/search/{SearchString} #

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

CustomerPeople

GET /v1/customers/{CustomerID}/people #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/people #

Responses

200 OK

PUT /v1/customers/people #

Responses

200 OK

Schemas: PersonModel

DELETE /v1/customers/people/{PersonID} #

Parameters

Name	In	Type	Required	Details	Description
`PersonID`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/people/{PersonID} #

Parameters

Name	In	Type	Required	Details	Description
`PersonID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/customers/people/{PersonID} #

Parameters

Name	In	Type	Required	Details	Description
`PersonID`	path	`string`	Yes

Responses

200 OK

Schemas: PersonModel

PUT /v1/customers/people/{PersonID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`PersonID`	path	`string`	Yes

Responses

200 OK

Schemas: NoteModel

GET /v1/customers/people/email/{email} #

Parameters

Name	In	Type	Required	Details	Description
`email`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/people/search/{SearchString} #

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

Customers

GET /v1/customers #

Responses

200 OK

POST /v1/customers #

Responses

200 OK

Schemas: CustomerModel

DELETE /v1/customers/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/customers/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerModel

PATCH /v1/customers/{CustomerID}/attributes #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerModel

POST /v1/customers/{CustomerID}/copyinto #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: CopyToTenantModel ProblemDetails

PUT /v1/customers/{CustomerID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: NoteModel

POST /v1/customers/{CustomerID}/templates #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerModel

GET /v1/customers/attributes/export #

Parameters

Name	In	Type	Required	Details	Description
`Format`	query	`string`	No	default: csv

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/customers/attributes/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/attributes/names #

Responses

200 OK

PATCH /v1/customers/batch #

Responses

200 OK

Schemas: CustomerModel

PUT /v1/customers/batch #

Responses

200 OK

Schemas: CustomerModel

GET /v1/customers/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/customers/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: CustomersSlicerModel ProblemDetails

GET /v1/customers/countries #

Responses

200 OK

GET /v1/customers/export #

Parameters

Name	In	Type	Required	Details	Description
`Format`	query	`string`	No	default: csv

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/customers/filter #

Responses

200 OK

Schemas: CustomersSlicerModel

GET /v1/customers/import/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/import/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/import/{ImportID}/summary #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/imports/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/imports/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/imports/{ImportID}/summary #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`limit`	query	`integer`	No	format: int32

Responses

200 OK

POST /v1/customers/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`limit`	query	`integer`	No	format: int32

Responses

200 OK

Schemas: CustomersSlicerModel

GET /v1/customers/productionorders #

Responses

200 OK

POST /v1/customers/records/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/regions #

Responses

200 OK

GET /v1/customers/search/{q} #

Parameters

Name	In	Type	Required	Details	Description
`q`	path	`string`	Yes
`limit`	query	`integer`	No	format: int32 default: 2147483647

Responses

200 OK

GET /v1/customers/sources #

Responses

200 OK

GET /v1/customers/terms #

Responses

200 OK

GET /v1/customers/verticals #

Responses

200 OK

CustomerShipTo

GET /v1/customers/{CustomerID}/shipto #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

PUT /v1/customers/{CustomerID}/shipto #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerShipToModel

DELETE /v1/customers/{CustomerID}/shipto/{ShipToID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes
`ShipToID`	path	`string`	Yes

Responses

200 OK

GET /v1/customers/{CustomerID}/shipto/{ShipToID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes
`ShipToID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/customers/{CustomerID}/shipto/{ShipToID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes
`ShipToID`	path	`string`	Yes

Responses

200 OK

Schemas: JToken

PUT /v1/customers/{CustomerID}/shipto/batch #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

Schemas: CustomerShipToModel

GET /v1/customers/shipto #

Responses

200 OK

GET /v1/customers/shipto/count #

Responses

200 OK

GET /v1/customers/shipto/export #

Parameters

Name	In	Type	Required	Details	Description
`Format`	query	`string`	No	default: csv

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/customers/shipto/import #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/import/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/import/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/imports/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/imports/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/imports/{ImportID}/summary #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/customers/shipto/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1
`RecordsPerPage`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

DefaultTags

GET /v1/setup/defaulttags #

Responses

200 OK

POST /v1/setup/defaulttags #

Responses

200 OK

Schemas: TagLabelModel

Delivery

GET /v1/delivery #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/delivery/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/delivery/options #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/delivery/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`recordcount`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DiagnosticTrees

GET /v1/service/diagnostictrees #

Responses

200 OK

PUT /v1/service/diagnostictrees #

Responses

200 OK

Schemas: DiagnosticTreeModel

DELETE /v1/service/diagnostictrees/{DiagnosticTreeID} #

Parameters

Name	In	Type	Required	Details	Description
`DiagnosticTreeID`	path	`string`	Yes

Responses

200 OK

GET /v1/service/diagnostictrees/{DiagnosticTreeID} #

Parameters

Name	In	Type	Required	Details	Description
`DiagnosticTreeID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/service/diagnostictrees/{DiagnosticTreeID} #

Parameters

Name	In	Type	Required	Details	Description
`DiagnosticTreeID`	path	`string`	Yes

Responses

200 OK

Schemas: DiagnosticTreeModel

Discussions

GET /v1/discussions/{primaryKeyId}/threads #

Parameters

Name	In	Type	Required	Details	Description
`primaryKeyId`	path	`string`	Yes

Responses

200 OK

POST /v1/discussions/{primaryKeyId}/threads #

Parameters

Name	In	Type	Required	Details	Description
`primaryKeyId`	path	`string`	Yes

Responses

200 OK

Schemas: DiscussionThreadModel

DELETE /v1/discussions/messages/{messageId} #

Parameters

Name	In	Type	Required	Details	Description
`messageId`	path	`string`	Yes

Responses

200 OK

GET /v1/discussions/messages/{messageId} #

Parameters

Name	In	Type	Required	Details	Description
`messageId`	path	`string`	Yes

Responses

200 OK

PUT /v1/discussions/messages/{messageId} #

Parameters

Name	In	Type	Required	Details	Description
`messageId`	path	`string`	Yes

Responses

200 OK

Schemas: DiscussionThreadMessageModel

GET /v1/discussions/threads #

Responses

200 OK

POST /v1/discussions/threads #

Responses

200 OK

Schemas: DiscussionThreadModel

DELETE /v1/discussions/threads/{threadId} #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

GET /v1/discussions/threads/{threadId} #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

PUT /v1/discussions/threads/{threadId} #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

Schemas: DiscussionThreadModel

GET /v1/discussions/threads/{threadId}/messages #

Parameters

Name	In	Type	Required	Details
`threadId`	path	`string`	Yes
`page`	query	`integer`	No	format: int32 default: 1
`size`	query	`integer`	No	format: int32 default: 50

Responses

200 OK

POST /v1/discussions/threads/{threadId}/messages #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

Schemas: DiscussionThreadMessageModel

GET /v1/discussions/threads/{threadId}/participants #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

POST /v1/discussions/threads/{threadId}/participants #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes

Responses

200 OK

Schemas: DiscussionParticipantModel

DELETE /v1/discussions/threads/{threadId}/participants/{userId} #

Parameters

Name	In	Type	Required	Details	Description
`threadId`	path	`string`	Yes
`userId`	path	`string`	Yes

Responses

200 OK

GET /v1/discussions/threads/search #

Parameters

Name	In	Type	Required	Details
`entityType`	query	`string`	No
`search`	query	`string`	No
`page`	query	`integer`	No	format: int32 default: 1
`size`	query	`integer`	No	format: int32 default: 50

Responses

200 OK

Documents

GET /v1/documents #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/documents #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DocumentUploadModel ProblemDetails

DELETE /v1/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DocumentModel ProblemDetails

GET /v1/documents/{DocumentID}/download #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/{DocumentID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/{DocumentID}/references/rules #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/documents/{DocumentID}/replace #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DocumentUploadModel ProblemDetails

GET /v1/documents/audit/files #

Responses

200 OK application/json

{
  "source": "example",
  "root": "example",
  "documentCount": 0,
  "connectedDocumentCount": 0,
  "localFoundFileCount": 0,
  "s3FoundFileCount": 0,
  "foundFileCount": 0,
  "missingFileCount": 0
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DocumentFilesAuditModel ProblemDetails

GET /v1/documents/bytype/{DocumentType} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentType`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`recordcount`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/types/{documenttype}/pages/{page} #

Parameters

Name	In	Type	Required	Details
`page`	path	`integer`	Yes	format: int32
`documenttype`	path	`string`	Yes	default: ANY
`recordcount`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Email

GET /v1/email #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/email #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EmailMessageModel ProblemDetails

DELETE /v1/email/{EmailID} #

Parameters

Name	In	Type	Required	Details	Description
`EmailID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/{EmailID} #

Parameters

Name	In	Type	Required	Details	Description
`EmailID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/search/{searchfor} #

Parameters

Name	In	Type	Required	Details	Description
`searchfor`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

EmailLog

GET /v1/email/logs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/logs/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

EmailTemplates

GET /v1/email/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/email/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EmailTemplateModel ProblemDetails

DELETE /v1/email/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/templates/{TemplateID} #

Parameters

Name	In	Type	Required
`TemplateID`	path	`string`	Yes
`SalesQuoteID`	query	`string`	No
`SalesOrderID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/email/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EmailTemplateModel ProblemDetails

GET /v1/email/templates/{TemplateID}/test #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Employee

GET /v1/employees #

Responses

200 OK

PUT /v1/employees #

Responses

200 OK

Schemas: EmployeeModel

DELETE /v1/employees/{EmployeeID} #

Parameters

Name	In	Type	Required	Details	Description
`EmployeeID`	path	`string`	Yes

Responses

200 OK

GET /v1/employees/{EmployeeID} #

Parameters

Name	In	Type	Required	Details	Description
`EmployeeID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/employees/{EmployeeID} #

Parameters

Name	In	Type	Required	Details	Description
`EmployeeID`	path	`string`	Yes

Responses

200 OK

Schemas: EmployeeModel

GET /v1/employees/search/{SearchString} #

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

GET /v1/employees/status #

Responses

200 OK

EscalationTemplates

GET /v1/escalation/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/escalation/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EscalationTemplateModel ProblemDetails

DELETE /v1/escalation/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/escalation/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/escalation/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EscalationTemplateModel ProblemDetails

Events

GET /v1/events #

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 1000

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/events/{EventID} #

Parameters

Name	In	Type	Required	Details	Description
`EventID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/events/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EventSlicerModel ProblemDetails

GET /v1/events/entities/{EntityID} #

Parameters

Name	In	Type	Required	Details	Description
`EntityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/events/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EventSlicerModel ProblemDetails

ForgeAiSetupJobs

POST /v1/forge/ai/jobs #

Responses

200 OK application/json

{
  "jobID": "example_001",
  "instanceID": "example_001",
  "productID": "example_001",
  "state": "example",
  "rowVersion": 0,
  "businessContext": {
    "businessProblem": "example",
    "targetMarket": "example",
    "targetCustomer": "example",
    "productFamily": "example",
    "productName": "Example name",
    "productSku": "example",
    "commercialIntent": "example",
    "defaultUnits": "example"
  },
  "package": {
    "schemaVersion": 0,
    "businessContext": "REDACTED",
    "product": "REDACTED",
    "pages": "example",
    "attributes": "example",
    "validValueSets": "example_001",
    "ruleGroups": "example",
    "rules": "example"
  },
  "validation": {
    "findings": "example",
    "hasBlockingFindings": false
  }
}

Schemas: ForgeAiBusinessContextModel ForgeAiSetupJobModel

GET /v1/forge/ai/jobs/{jobID} #

Parameters

Name	In	Type	Required	Details	Description
`jobID`	path	`string`	Yes

Responses

200 OK application/json

{
  "jobID": "example_001",
  "instanceID": "example_001",
  "productID": "example_001",
  "state": "example",
  "rowVersion": 0,
  "businessContext": {
    "businessProblem": "example",
    "targetMarket": "example",
    "targetCustomer": "example",
    "productFamily": "example",
    "productName": "Example name",
    "productSku": "example",
    "commercialIntent": "example",
    "defaultUnits": "example"
  },
  "package": {
    "schemaVersion": 0,
    "businessContext": "REDACTED",
    "product": "REDACTED",
    "pages": "example",
    "attributes": "example",
    "validValueSets": "example_001",
    "ruleGroups": "example",
    "rules": "example"
  },
  "validation": {
    "findings": "example",
    "hasBlockingFindings": false
  }
}

Schemas: ForgeAiSetupJobModel

PATCH /v1/forge/ai/jobs/{jobID}/context #

Parameters

Name	In	Type	Required	Details	Description
`jobID`	path	`string`	Yes

Responses

200 OK application/json

{
  "jobID": "example_001",
  "instanceID": "example_001",
  "productID": "example_001",
  "state": "example",
  "rowVersion": 0,
  "businessContext": {
    "businessProblem": "example",
    "targetMarket": "example",
    "targetCustomer": "example",
    "productFamily": "example",
    "productName": "Example name",
    "productSku": "example",
    "commercialIntent": "example",
    "defaultUnits": "example"
  },
  "package": {
    "schemaVersion": 0,
    "businessContext": "REDACTED",
    "product": "REDACTED",
    "pages": "example",
    "attributes": "example",
    "validValueSets": "example_001",
    "ruleGroups": "example",
    "rules": "example"
  },
  "validation": {
    "findings": "example",
    "hasBlockingFindings": false
  }
}

Schemas: ForgeAiSetupJobModel ForgeAiUpdateBusinessContextRequestModel

PATCH /v1/forge/ai/jobs/{jobID}/package #

Parameters

Name	In	Type	Required	Details	Description
`jobID`	path	`string`	Yes

Responses

200 OK application/json

{
  "jobID": "example_001",
  "instanceID": "example_001",
  "productID": "example_001",
  "state": "example",
  "rowVersion": 0,
  "businessContext": {
    "businessProblem": "example",
    "targetMarket": "example",
    "targetCustomer": "example",
    "productFamily": "example",
    "productName": "Example name",
    "productSku": "example",
    "commercialIntent": "example",
    "defaultUnits": "example"
  },
  "package": {
    "schemaVersion": 0,
    "businessContext": "REDACTED",
    "product": "REDACTED",
    "pages": "example",
    "attributes": "example",
    "validValueSets": "example_001",
    "ruleGroups": "example",
    "rules": "example"
  },
  "validation": {
    "findings": "example",
    "hasBlockingFindings": false
  }
}

Schemas: ForgeAiSetupJobModel ForgeAiUpdatePackageRequestModel

POST /v1/forge/ai/jobs/{jobID}/transitions #

Parameters

Name	In	Type	Required	Details	Description
`jobID`	path	`string`	Yes

Responses

200 OK application/json

{
  "succeeded": false,
  "previousState": "example",
  "state": "example",
  "error": "example",
  "allowedCommands": "example"
}

Schemas: ForgeAiTransitionRequestModel ForgeAiTransitionResultModel

GlobalIncoTerms

GET /v1/global/incoterms #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/global/incoterms #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: IncotermDefinitionModel ProblemDetails

DELETE /v1/global/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/global/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/global/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: IncotermDefinitionModel ProblemDetails

POST /v1/global/incoterms/{TermID}/copy-to-tenant #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

409 Conflict application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Home

GET /v1/home/dashboard #

Parameters

Name	In	Type	Required	Details
`preferenceQuotes`	query	`string`	No	default: My
`preferenceOrders`	query	`string`	No	default: My
`tourId`	query	`string`	No

Responses

200 OK application/json

{
  "recentViews": "example",
  "phasesQuotes": "example",
  "phasesProduction": "example",
  "notes": "example",
  "toDoFunnel": "example",
  "toDoSalesQuotes": "example",
  "toDoSalesOrders": "example",
  "tour": {
    "tourID": "example_001",
    "completed": false,
    "completedUTC": "2026-01-15T12:00:00Z"
  }
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: HomeModel ProblemDetails

Import

GET /v1/imports #

Get Imports supported for instance

Responses

200 OK

GET /v1/imports/{ImportID} #

Import a datafile

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`FileName`	query	`string`	No

Responses

200 OK

POST /v1/imports/{ImportID} #

Import a datafile

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

POST /v1/imports/{ImportID}/reset #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/imports/active #

Get Active Imports supported for instance

Responses

200 OK

GET /v1/imports/jobs/running #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Instance

GET /v1/instances/{InstanceID} #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/{InstanceID}/customization #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

POST /v1/instances/{InstanceID}/customization #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

Schemas: AppForgeSettingsModel

GET /v1/instances/{InstanceID}/features/{feature}/requestaccess #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`feature`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/{InstanceID}/logo #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

POST /v1/instances/{InstanceID}/logo #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/{InstanceID}/settings #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

POST /v1/instances/{InstanceID}/settings #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

Schemas: AppForgeSettingsModel

DELETE /v1/instances/{InstanceID}/settings/sftp-export #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/{InstanceID}/settings/sftp-export #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

POST /v1/instances/{InstanceID}/settings/sftp-export #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

Schemas: SftpExportUpdateModel

POST /v1/instances/{InstanceID}/settings/sftp-export/test #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/configurationhistory #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/instances/defaulttags #

Responses

200 OK

Schemas: TagLabelModel

GET /v1/instances/phases #

Responses

200 OK

DELETE /v1/instances/smtpserver #

Responses

200 OK

GET /v1/instances/smtpserver #

Responses

200 OK

PATCH /v1/instances/smtpserver #

Responses

200 OK

Schemas: EmailServerModel

GET /v1/instances/smtpserver/test #

Responses

200 OK

GET /v1/tenants/summary #

Responses

200 OK

InstanceGroupMembers

GET /v1/instances/{InstanceID}/groups/memberships #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/groups/{GroupID}/members #

Parameters

Name	In	Type	Required	Details	Description
`GroupID`	path	`string`	Yes

Responses

200 OK

POST /v1/instances/groups/{GroupID}/members #

Parameters

Name	In	Type	Required	Details	Description
`GroupID`	path	`string`	Yes

Responses

200 OK

Schemas: TenantGroupMemberModel

InstanceGroups

GET /v1/instances/{InstanceID}/groups #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/groups #

Responses

200 OK

POST /v1/instances/groups #

Responses

200 OK

Schemas: TenantGroupModel

DELETE /v1/instances/groups/{GroupID} #

Parameters

Name	In	Type	Required	Details	Description
`GroupID`	path	`string`	Yes

Responses

200 OK

GET /v1/instances/groups/{GroupID} #

Parameters

Name	In	Type	Required	Details	Description
`GroupID`	path	`string`	Yes

Responses

200 OK

InstanceInvoices

GET /v1/instance/invoices #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No	default: DRAFT

Responses

200 OK

PUT /v1/instance/invoices #

Responses

200 OK

Schemas: InvoiceModel

GET /v1/instance/invoices/{InvoiceID} #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/instance/invoices/{InvoiceID} #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

Schemas: InvoiceModel

GET /v1/instance/invoices/{InvoiceID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/instance/invoices/bycustomer/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/instance/invoices/search/{q} #

Parameters

Name	In	Type	Required	Details	Description
`q`	path	`string`	Yes

Responses

200 OK

Instructions

GET /v1/instructions #

Get instructions ByTaskID

Responses

200 OK

GET /v1/instructions/{InstructionID} #

Get by ID

Parameters

Name	In	Type	Required	Details	Description
`InstructionID`	path	`string`	Yes

Responses

200 OK

POST /v1/instructions/{taskid} #

Update

Parameters

Name	In	Type	Required	Details	Description
`taskid`	path	`string`	Yes

Responses

200 OK

Schemas: InstructionModel

GET /v1/instructions/tasks/{taskid} #

GetByTaskID

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

Integrations

GET /v1/instances/{InstanceID}/integrations #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: IntegrationModel ProblemDetails

GET /v1/instances/{InstanceID}/integrations/{IntegrationID} #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`IntegrationID`	path	`string`	Yes

Responses

200 OK application/json

{
  "integrationID": "example_001",
  "name": "Example name",
  "provider": "example_001",
  "providerJSON": "example_001",
  "actions": "example",
  "helcimConfig": {
    "accountID": "example_001",
    "apiToken": "REDACTED",
    "environment": "example",
    "webhookSecret": "REDACTED",
    "isActive": "example"
  },
  "slackConfig": {
    "webhooks": "example"
  },
  "isActive": false
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: IntegrationModel ProblemDetails

PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`IntegrationID`	path	`string`	Yes

Responses

200 OK application/json

{
  "success": false,
  "message": "example",
  "errors": "example",
  "errorCode": "example",
  "data": 0
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: Int32ApiResponseModel IntegrationExecuteRequestModel ProblemDetails

Inventory

PUT /v1/inventory #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemLedgerModel ProblemDetails

POST /v1/inventory/availability/assessments #

Responses

200 OK application/json

{
  "source": "example",
  "snapshotAtUTC": "2026-01-15T12:00:00Z",
  "isHealthy": false,
  "items": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

403 Forbidden application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryAvailabilityAssessmentModel InventoryAvailabilityAssessmentRequestModel ProblemDetails

POST /v1/inventory/availability/shortages #

Responses

200 OK

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

403 Forbidden application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryShortageNotificationModel ProblemDetails

GET /v1/inventory/createtestdata #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/demand/analyzer #

Parameters

Name	In	Type	Required	Details	Description
`DaysLookback`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/inventory/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/import/results #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/items/{ItemID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/inventory/move #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryTransferModel ProblemDetails

PUT /v1/inventory/receive #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryReceiveModel ProblemDetails

GET /v1/inventory/status #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/status/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/status/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/inventory/status/pages/{Page} #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

InventoryLocations

GET /v1/inventory/locations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/inventory/locations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryLocationsSlicerModel ProblemDetails

PUT /v1/inventory/locations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryLocationModel ProblemDetails

GET /v1/inventory/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/inventory/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryLocationModel ProblemDetails

PATCH /v1/inventory/locations/{LocationID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: InventoryLocationModel ProblemDetails

GET /v1/inventory/locations/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/inventory/locations/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Invoices

GET /v1/invoices #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No	default: DRAFT

Responses

200 OK

PUT /v1/invoices #

Responses

200 OK

Schemas: InvoiceModel

GET /v1/invoices/{InvoiceID} #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/invoices/{InvoiceID} #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

Schemas: InvoiceModel

GET /v1/invoices/{InvoiceID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`InvoiceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/invoices/bycustomer/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/invoices/search/{q} #

Parameters

Name	In	Type	Required	Details	Description
`q`	path	`string`	Yes

Responses

200 OK

ItemCompatibility

GET /v1/items/{ItemID}/compatibility #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/compatibility #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/items/compatibility #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemCompatibilityModel ProblemDetails

DELETE /v1/items/compatibility/{CompatibilityID} #

Parameters

Name	In	Type	Required	Details	Description
`CompatibilityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/compatibility/{CompatibilityID} #

Parameters

Name	In	Type	Required	Details	Description
`CompatibilityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/items/compatibility/{CompatibilityID} #

Parameters

Name	In	Type	Required	Details	Description
`CompatibilityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemCompatibilityModel ProblemDetails

GET /v1/items/compatibility/search #

Parameters

Name	In	Type	Required	Details	Description
`q`	query	`string`	No
`limit`	query	`integer`	No	format: int32 default: 100

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ItemContractPricing

GET /v1/items/contractpricing #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ItemMapping

PATCH /v1/itemmapping #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemMappingModel ProblemDetails

PUT /v1/itemmapping #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemMappingModel ProblemDetails

DELETE /v1/itemmapping/{ItemMappingID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemMappingID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ItemMappingID}/detail #

Parameters

Name	In	Type	Required	Details	Description
`ItemMappingID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/itemmapping/{ItemMappingID}/history #

Parameters

Name	In	Type	Required	Details	Description
`ItemMappingID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemMappingModel ProblemDetails

GET /v1/itemmapping/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/itemmapping/{ProductID}/all #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/categories #

Get Categories

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/count #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`Category`	query	`string`	No	default: ALL

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/export #

Get as CSV

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`Format`	query	`string`	No	default: JSON

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/itemmapping/{ProductID}/import #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`ReplaceExisting`	query	`boolean`	No	default: false

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/match/{AttributesAndValues} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`AttributesAndValues`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/pages/{Page} #

Parameters

Name	In	Type	Required	Details
`ProductID`	path	`string`	Yes
`Category`	query	`string`	No
`Page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/search/{SearchFor} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SearchFor`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/{ProductID}/validate #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SearchFor`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/products/{ProductID}/categories #

Get Categories

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/itemmapping/products/{ProductID}/export #

Get as CSV

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`Format`	query	`string`	No	default: JSON

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping/count #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`Category`	query	`string`	No	default: ALL

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/products/{ProductID}/itemmapping/import #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`ReplaceExisting`	query	`boolean`	No	default: false

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping/match/{AttributesAndValues} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`AttributesAndValues`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping/pages/{Page} #

Parameters

Name	In	Type	Required	Details
`ProductID`	path	`string`	Yes
`Category`	query	`string`	No
`Page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping/search/{SearchFor} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SearchFor`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/itemmapping/validate #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SearchFor`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ItemPromotions

GET /v1/items/promotions #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ItemReviews

GET /v1/items/reviews #

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 2147483647

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/items/reviews #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemCostReviewModel ProblemDetails

DELETE /v1/items/reviews/{ReviewID} #

Parameters

Name	In	Type	Required	Details	Description
`ReviewID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/reviews/{ReviewID} #

Parameters

Name	In	Type	Required	Details	Description
`ReviewID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/items/reviews/{ReviewID}/basics #

Parameters

Name	In	Type	Required	Details	Description
`ReviewID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemCostReviewModel ProblemDetails

GET /v1/items/reviews/{ReviewID}/references #

Parameters

Name	In	Type	Required	Details	Description
`ReviewID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Items

GET /v1/items #

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 2147483647

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/items #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

DELETE /v1/items/{ItemID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/{ItemID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/items/{ItemID}/attributes #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

PATCH /v1/items/{ItemID}/basics #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

POST /v1/items/{ItemID}/copyinto #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: CopyToTenantModel ProblemDetails

POST /v1/items/{ItemID}/costandpricecheck #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/items/{ItemID}/documents #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes
`Description`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/items/{ItemID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/{ItemID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/items/{ItemID}/links #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

PATCH /v1/items/{ItemID}/pricebreaks #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

GET /v1/items/{ItemID}/references #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/items/{ItemID}/review #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemReviewModel ProblemDetails

PATCH /v1/items/{ItemID}/router #

Parameters

Name	In	Type	Required	Details	Description
`ItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

DELETE /v1/items/all #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/attributes/summary #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/attributes/withvalues #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/items/batch #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

PUT /v1/items/batch #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

POST /v1/items/byids #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/bynumber/{Number} #

Parameters

Name	In	Type	Required	Details	Description
`Number`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/categories #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/items/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemsSlicerModel ProblemDetails

GET /v1/items/countries #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/export #

Parameters

Name	In	Type	Required	Details	Description
`what`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/items/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/import/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/import/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/import/summary #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/items/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemsSlicerModel ProblemDetails

POST /v1/items/product-finder #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductFinderQueryModel

GET /v1/items/recent #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/search/{q} #

Parameters

Name	In	Type	Required	Details	Description
`q`	path	`string`	Yes
`limit`	query	`integer`	No	format: int32 default: 2147483647

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/items #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ItemsAnalysis

POST /v1/items/analysis/costandprice #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemsSlicerModel ProblemDetails

Localization

GET /v1/localization #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Locations

GET /v1/locations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/locations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: LocationModel ProblemDetails

DELETE /v1/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/locations/{LocationID} #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: LocationModel ProblemDetails

GET /v1/locations/{LocationID}/nonworkingdays/export #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/locations/{LocationID}/nonworkingdays/import #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	path	`string`	Yes
`ImportID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/locations/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/imports/{ImportID}/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/imports/{ImportID}/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`ImportID`	path	`string`	Yes
`LogType`	query	`string`	No	default: MESSAGES
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/imports/{ImportID}/summary #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/nonworkingdays/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/locations/nonworkingdays/import #

Parameters

Name	In	Type	Required	Details	Description
`ImportID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

MaintenancePlans

GET /v1/maintenance/plans #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/maintenance/plans #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: MaintenancePlanModel ProblemDetails

DELETE /v1/maintenance/plans/{PlanID} #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/maintenance/plans/{PlanID} #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/maintenance/plans/{PlanID} #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: MaintenancePlanModel ProblemDetails

POST /v1/maintenance/plans/{PlanID}/documents #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes
`Description`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/maintenance/plans/{PlanID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/maintenance/plans/{PlanID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`PlanID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/maintenance/plans/count #

Parameters

Name	In	Type	Required	Details	Description
`IsActive`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/maintenance/plans/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`IsActive`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Notes

GET /v1/notes/prodorders #

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/notes/prodordertasks #

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/notes/salesorders #

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/notes/salesquotes #

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Notifications

GET /v1/notifications #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No	default: U

Responses

200 OK

GET /v1/notifications/{NotificationID} #

Parameters

Name	In	Type	Required	Details	Description
`NotificationID`	path	`string`	Yes

Responses

200 OK

GET /v1/notifications/{NotificationID}/dismiss #

Parameters

Name	In	Type	Required	Details	Description
`NotificationID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/notifications/{NotificationID}/status #

Parameters

Name	In	Type	Required	Details	Description
`NotificationID`	path	`string`	Yes

Responses

200 OK

GET /v1/notifications/all/dismiss #

Responses

200 OK

PUT /v1/notifications/sendtoall #

Responses

200 OK

Schemas: NotificationModel

PUT /v1/notifications/sendtorole/{Role} #

Parameters

Name	In	Type	Required	Details	Description
`Role`	path	`string`	Yes

Responses

200 OK

Schemas: NotificationModel

PUT /v1/notifications/sendtouser #

Responses

200 OK

Schemas: NotificationModel

GET /v1/notifications/system #

Responses

200 OK

OrganizationIncoterms

GET /v1/incoterms #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/incoterms #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: OrganizationIncotermModel ProblemDetails

DELETE /v1/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/incoterms/{TermID} #

Parameters

Name	In	Type	Required	Details	Description
`TermID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: OrganizationIncotermModel ProblemDetails

PackingList

GET /v1/packinglists #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/packinglists #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PackingListModel ProblemDetails

DELETE /v1/packinglists/{PackingListID} #

Parameters

Name	In	Type	Required	Details	Description
`PackingListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/packinglists/{PackingListID} #

Parameters

Name	In	Type	Required	Details	Description
`PackingListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/packinglists/{PackingListID} #

Parameters

Name	In	Type	Required	Details	Description
`PackingListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PackingListModel ProblemDetails

GET /v1/packinglists/{PackingListID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`PackingListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Pages

PUT /v1/pages #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionPageModel ProblemDetails

DELETE /v1/pages/{PageID} #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`PageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pages/{PageID} #

Parameters

Name	In	Type	Required	Details	Description
`PageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/pages/{PageID} #

Update

Parameters

Name	In	Type	Required	Details	Description
`PageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionPageModel ProblemDetails

GET /v1/pages/{PageID}/attributes/renumber #

Parameters

Name	In	Type	Required	Details	Description
`PageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pages/{PageID}/attributes/renumber/alpha #

Parameters

Name	In	Type	Required	Details	Description
`PageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/pages/batch #

Add

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionPageModel ProblemDetails

GET /v1/pages/products/{ProductID} #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pages/products/{ProductID}/count #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/pages #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/pages/count #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Phases

GET /v1/phases #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/phases #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PhaseModel ProblemDetails

DELETE /v1/phases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/phases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/phases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PhaseModel ProblemDetails

PriceLists

GET /v1/pricelists #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/pricelists #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PriceListModel ProblemDetails

DELETE /v1/pricelists/{ListID} #

Parameters

Name	In	Type	Required	Details	Description
`ListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pricelists/{ListID} #

Parameters

Name	In	Type	Required	Details	Description
`ListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/pricelists/{ListID} #

Parameters

Name	In	Type	Required	Details	Description
`ListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PriceListModel ProblemDetails

GET /v1/pricelists/{ListID}/items #

Parameters

Name	In	Type	Required	Details	Description
`ListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/pricelists/{ListID}/items #

Parameters

Name	In	Type	Required	Details	Description
`ListID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PriceListItemModel ProblemDetails

PricingChangeRequests

POST /v1/pricing-change-requests #

Responses

200 OK application/json

{
  "pricingChangeRequestID": "example_001",
  "message": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PricingChangeRequestModel PricingChangeRequestReceipt ProblemDetails

PricingComponents

GET /v1/pricingcomponents #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/pricingcomponents #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PricingComponentModel ProblemDetails

DELETE /v1/pricingcomponents/{PricingComponentID} #

Parameters

Name	In	Type	Required	Details	Description
`PricingComponentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pricingcomponents/{PricingComponentID} #

Parameters

Name	In	Type	Required	Details	Description
`PricingComponentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/pricingcomponents/{PricingComponentID} #

Parameters

Name	In	Type	Required	Details	Description
`PricingComponentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: PricingComponentModel ProblemDetails

GET /v1/pricingcomponents/{PricingComponentID}/references/items #

Parameters

Name	In	Type	Required	Details	Description
`PricingComponentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pricingcomponents/{PricingComponentID}/references/tasks #

Parameters

Name	In	Type	Required	Details	Description
`PricingComponentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ProductAiApply

POST /v1/products/{productID}/ai/apply #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes

Responses

200 OK application/json

{
  "requestID": "example_001",
  "deletedPages": 0,
  "deletedAttributes": 0,
  "deletedRuleGroups": 0,
  "deletedRules": 0,
  "createdPages": 0,
  "createdAttributes": 0,
  "createdRuleGroups": 0
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

409 Conflict application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductAiApplyRequestModel ProductSetupAiApplyResultModel

ProductChangeRequests

POST /v1/product-change-requests #

Responses

200 OK application/json

{
  "productChangeRequestID": "example_001",
  "processID": "example_001",
  "message": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductChangeRequestModel ProductChangeRequestReceipt

ProductFamilies

GET /v1/products/families #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/products/families #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductFamilyModel

DELETE /v1/products/families/{FamilyID} #

Parameters

Name	In	Type	Required	Details	Description
`FamilyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/families/{FamilyID} #

Parameters

Name	In	Type	Required	Details	Description
`FamilyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/products/families/{FamilyID} #

Parameters

Name	In	Type	Required	Details	Description
`FamilyID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductFamilyModel

GET /v1/products/families/alphabetize #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/families/renumber #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ProductionOrderEscalations

GET /v1/dashboard/escalations #

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 3

Responses

200 OK application/json

{
  "items": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DashboardEscalationsResponse ProblemDetails

GET /v1/prodorders/{ProductionOrderID}/escalations #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/escalations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/escalations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderEscalationSlicerModel

PUT /v1/prodorders/escalations #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderEscalationPostModel

DELETE /v1/prodorders/escalations/{EscalationID} #

Parameters

Name	In	Type	Required	Details	Description
`EscalationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/escalations/{EscalationID} #

Parameters

Name	In	Type	Required	Details	Description
`EscalationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/prodorders/escalations/{EscalationID} #

Parameters

Name	In	Type	Required	Details	Description
`EscalationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderEscalationModel

GET /v1/prodorders/escalations/active #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/escalations/count #

Parameters

Name	In	Type	Required	Details
`CreatedByUserID`	query	`string`	No
`Status`	query	`string`	No
`CustomerID`	query	`string`	No
`CreatedUTCYear`	query	`integer`	No	format: int32
`CreatedUTCMonth`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/escalations/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderEscalationSlicerModel

ProductionOrderImages

GET /v1/prodorders/{ProductionOrderID}/images #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/{ProductionOrderID}/images #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/prodorders/{ProductionOrderID}/images/{ImageID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/{ProductionOrderID}/images/{ImageID} #

Parameters

Name	In	Type	Required	Details	Description
`ImageID`	path	`string`	Yes
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/prodorders/{ProductionOrderID}/images/{ImageID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ImageModel ProblemDetails

GET /v1/prodorders/{ProductionOrderID}/images/{ImageID}/download #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/{ProductionOrderID}/images/{ImageID}/replace #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ProductionOrderPhases

GET /v1/productionorderphases #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/productionorderphases #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderPhaseModel

DELETE /v1/productionorderphases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/productionorderphases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/productionorderphases/{PhaseID} #

Parameters

Name	In	Type	Required	Details	Description
`PhaseID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionOrderPhaseModel

ProductionOrders

GET /v1/prodorders #

Responses

200 OK

POST /v1/prodorders #

Responses

200 OK

Schemas: ProductionOrderSlicerModel

GET /v1/prodorders/{ProductionOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

POST /v1/prodorders/{ProductionOrderID}/cancel #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderCancelModel

POST /v1/prodorders/{ProductionOrderID}/documents #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`Description`	query	`string`	No

Responses

200 OK

DELETE /v1/prodorders/{ProductionOrderID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/{ProductionOrderID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

POST /v1/prodorders/{ProductionOrderID}/documents/alpha #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/prodorders/{ProductionOrderID}/history #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/lotnumbers #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

GET /v1/prodorders/{ProductionOrderID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`DocumentID`	query	`string`	No

Responses

200 OK

GET /v1/prodorders/{ProductionOrderID}/pdf/validate #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`DocumentID`	query	`string`	No

Responses

200 OK

PATCH /v1/prodorders/{ProductionOrderID}/phase #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/serialnumbers #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/tags #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/tasks #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderModel

POST /v1/prodorders/{ProductionOrderID}/tasks/{ProductionOrderTaskID}/status #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ProductionOrderTaskID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderTaskStatusUpdateRequest

GET /v1/prodorders/{ProductionOrderID}/tasks/{TaskID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required
`ProductionOrderID`	path	`string`	Yes
`TaskID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/prodorders/assignedto #

Responses

200 OK

Schemas: ProductionOrderModel

GET /v1/prodorders/bycustomers #

Parameters

Name	In	Type	Required	Details	Description
`status`	query	`integer`	No	format: int32 default: -10

Responses

200 OK

GET /v1/prodorders/byphase/{phase} #

Parameters

Name	In	Type	Required	Details	Description
`phase`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/bypriority/{priority} #

Parameters

Name	In	Type	Required	Details	Description
`Priority`	path	`string`	Yes
`Count`	query	`integer`	No	format: int32

Responses

200 OK

GET /v1/prodorders/bysalesorder/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/byserviceticketline/{serviceTicketLineItemID} #

Parameters

Name	In	Type	Required	Details	Description
`serviceTicketLineItemID`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/bystatus/{Status} #

Parameters

Name	In	Type	Required	Details	Description
`Status`	path	`integer`	Yes	format: int32
`Count`	query	`integer`	No	format: int32

Responses

200 OK

GET /v1/prodorders/count #

Responses

200 OK

POST /v1/prodorders/count #

Responses

200 OK

Schemas: ProductionOrderSlicerModel

PATCH /v1/prodorders/createdby #

Responses

200 OK

Schemas: UpdateCreatedByModel

GET /v1/prodorders/customers #

Responses

200 OK

GET /v1/prodorders/export #

Responses

200 OK

POST /v1/prodorders/import #

Responses

200 OK

GET /v1/prodorders/pages/{Page} #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

POST /v1/prodorders/pages/{Page} #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

Schemas: ProductionOrderSlicerModel

POST /v1/prodorders/pages/{Page}/customers #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

Schemas: ProductionOrderSlicerModel

POST /v1/prodorders/pages/{Page}/salesorders #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

Schemas: ProductionOrderSlicerModel

PATCH /v1/prodorders/plannedstart #

Responses

200 OK

Schemas: ProductionOrderModel

GET /v1/prodorders/search #

Parameters

Name	In	Type	Required	Details	Description
`q`	query	`string`	No

Responses

200 OK

GET /v1/prodorders/search/{searchfor} #

Parameters

Name	In	Type	Required	Details	Description
`q`	query	`string`	No
`searchfor`	path	`string`	Yes

Responses

200 OK

PATCH /v1/prodorders/sequencenumber #

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/status #

Responses

200 OK

Schemas: ProductionOrderModel

ProductionOrdersBatch

GET /v1/prodorders/batches #

Responses

200 OK

PUT /v1/prodorders/batches #

Responses

200 OK

Schemas: ProductionOrderBatchModel

DELETE /v1/prodorders/batches/{BatchID} #

Parameters

Name	In	Type	Required	Details	Description
`BatchID`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/batches/{BatchID} #

Parameters

Name	In	Type	Required	Details	Description
`BatchID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/prodorders/batches/{BatchID} #

Parameters

Name	In	Type	Required	Details	Description
`BatchID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderBatchModel

ProductionOrderTimeEvents

GET /v1/events/prodorders/export #

Responses

200 OK

POST /v1/events/prodorders/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

GET /v1/events/prodorders/invalid-time #

Lists clock records excluded from profitability calculations. This is a read-only repair worklist.

Parameters

Name	In	Type	Required	Details	Description
`download`	query	`boolean`	No	default: false

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionTimeLedgerAuditRowModel

GET /v1/prodorders/{ProductionOrderID}/events #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/{ProductionOrderID}/Tasks/{ProductionOrderTaskID}/clockin #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ProductionOrderTaskID`	path	`string`	Yes

Responses

200 OK

POST /v1/prodorders/{ProductionOrderID}/Tasks/{ProductionOrderTaskID}/clockout #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes
`ProductionOrderTaskID`	path	`string`	Yes

Responses

200 OK

GET /v1/prodorders/events #

Parameters

Name	In	Type	Required	Details	Description
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/events #

Parameters

Name	In	Type	Required	Details	Description
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

POST /v1/prodorders/events/analysis/month #

Responses

200 OK application/json

{
  "months": "example",
  "totalEvents": 0
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel ProductionOrderEventsByMonthModel

GET /v1/prodorders/events/bootstrap #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/events/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

GET /v1/prodorders/events/filters #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/events/page/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

GET /v1/prodorders/events/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/events/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

GET /v1/prodorders/events/prodorders #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/events/products #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/events/salesorders #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/events/users #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/events/users/{UserID}/clockedin #

Parameters

Name	In	Type	Required	Details	Description
`UserID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/tasks/{TaskName}/events #

Parameters

Name	In	Type	Required	Details	Description
`TaskName`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/tasks/{TaskName}/events/count #

Parameters

Name	In	Type	Required	Details	Description
`TaskName`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/prodorders/tasks/{TaskName}/events/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`TaskName`	path	`string`	Yes
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/prodorders/timeevents/{EventID} #

Parameters

Name	In	Type	Required	Details	Description
`EventID`	path	`string`	Yes

Responses

200 OK

Products

GET /v1/products #

Parameters

Name	In	Type	Required	Details	Description
`IsActive`	query	`string`	No	default: ANY

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/products #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

DELETE /v1/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

PATCH /v1/products/{ProductID}/attributes/pricing/reset #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/products/{ProductID}/copyinto #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: CopyToTenantModel ProblemDetails

POST /v1/products/{ProductID}/documents #

Parameters

Name	In	Type	Required
`ProductID`	path	`string`	Yes
`name`	query	`string`	No
`revision`	query	`string`	No
`description`	query	`string`	No
`visibility`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/products/{ProductID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/products/{ProductID}/Duplicate #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/products/{ProductID}/image #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

PATCH /v1/products/{ProductID}/images #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

PATCH /v1/products/{ProductID}/Links #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

PATCH /v1/products/{ProductID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

GET /v1/products/{ProductID}/references/build #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/references/items #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/products/{ProductID}/store #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

PATCH /v1/products/{ProductID}/tags #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

GET /v1/products/{ProductID}/validate #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/search/{number} #

Parameters

Name	In	Type	Required	Details	Description
`number`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/validate #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ProductSnapshots

GET /v1/products/{ProductID}/snapshots #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/products/{ProductID}/snapshots #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductSnapshotModel

GET /v1/products/{ProductID}/snapshots/{SnapshotID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SnapshotID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/products/{ProductID}/snapshots/{SnapshotID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`SnapshotID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductSnapshotModel

ProductTakeRateAnalyses

GET /v1/products/{productID}/take-rate-analyses #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes

Responses

200 OK

PUT /v1/products/{productID}/take-rate-analyses #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductTakeRateAnalysisModel

DELETE /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes
`analysisID`	path	`string`	Yes

Responses

200 OK

GET /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes
`analysisID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

Name	In	Type	Required	Details	Description
`productID`	path	`string`	Yes
`analysisID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductTakeRateAnalysisModel

Promotions

GET /v1/promotions #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/promotions #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails PromotionModel

DELETE /v1/promotions/{PromotionID} #

Parameters

Name	In	Type	Required	Details	Description
`PromotionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/promotions/{PromotionID} #

Parameters

Name	In	Type	Required	Details	Description
`PromotionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/promotions/{PromotionID} #

Parameters

Name	In	Type	Required	Details	Description
`PromotionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails PromotionModel

GET /v1/promotions/{PromotionID}/salesquote/add #

Parameters

Name	In	Type	Required	Details	Description
`PromotionID`	path	`string`	Yes
`SalesQuoteID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Purchasing

GET /v1/purchasing #

Responses

200 OK

GET /v1/purchasing/watchlist #

Gets all items that match active purchasing watch rules.

Responses

200 OK application/json

"example"

Schemas: PurchasingWatchHitModel

PurchasingRules

GET /v1/purchasing/rules #

Gets all purchasing watch rules for the instance.

Responses

200 OK

POST /v1/purchasing/rules #

Creates a new purchasing watch rule.

Responses

201 Created

Schemas: PurchasingWatchRuleModel

DELETE /v1/purchasing/rules/{id} #

Deletes a purchasing watch rule.

Parameters

Name	In	Type	Required	Details	Description
`id`	path	`string`	Yes

Responses

204 No Content

PUT /v1/purchasing/rules/{id} #

Updates an existing purchasing watch rule.

Parameters

Name	In	Type	Required	Details	Description
`id`	path	`string`	Yes

Responses

204 No Content

Schemas: PurchasingWatchRuleModel

QualityAssets

GET /v1/quality/assets #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/assets #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAssetModel

DELETE /v1/quality/assets/{AssetID} #

Parameters

Name	In	Type	Required	Details	Description
`AssetID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/assets/{AssetID} #

Parameters

Name	In	Type	Required	Details	Description
`AssetID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/assets/{AssetID} #

Parameters

Name	In	Type	Required	Details	Description
`AssetID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAssetModel

PATCH /v1/quality/assets/{AssetID}/Notes #

Parameters

Name	In	Type	Required	Details	Description
`AssetID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAssetModel

GET /v1/quality/assets/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/assets/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/assets/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/assets/import/results #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/assets/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/assets/search/{search} #

Parameters

Name	In	Type	Required	Details	Description
`search`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

QualityAudits

GET /v1/quality/audits #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/audits #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAuditModel

DELETE /v1/quality/audits/{AuditID} #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/audits/{AuditID} #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/audits/{AuditID} #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAuditModel

PATCH /v1/quality/audits/{AuditID}/findings #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAuditModel

PATCH /v1/quality/audits/{AuditID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`AuditID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityAuditModel

QualityCapa

GET /v1/quality/capa #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/capa #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityCapaModel

DELETE /v1/quality/capa/{QualityCapaID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityCapaID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/capa/{QualityCapaID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityCapaID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/capa/{QualityCapaID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityCapaID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityCapaModel

PATCH /v1/quality/capa/{QualityCapaID}/Phases/{Phase}/Notes #

Parameters

Name	In	Type	Required	Details	Description
`QualityCapaID`	path	`string`	Yes
`Phase`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityCapaModel

QualityChanges

GET /v1/quality/changes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/changes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityChangeModel

DELETE /v1/quality/changes/{ChangeID} #

Parameters

Name	In	Type	Required	Details	Description
`ChangeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/changes/{ChangeID} #

Parameters

Name	In	Type	Required	Details	Description
`ChangeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/changes/{ChangeID} #

Parameters

Name	In	Type	Required	Details	Description
`ChangeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityChangeModel

PATCH /v1/quality/changes/{ChangeID}/Notes #

Parameters

Name	In	Type	Required	Details	Description
`ChangeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityChangeModel

QualityDocuments

GET /v1/quality/documents #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/quality/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityDocumentModel

GET /v1/quality/documents/{DocumentID}/download #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/documents/{DocumentID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityDocumentModel

POST /v1/quality/documents/add #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityDocumentUploadModel

GET /v1/quality/documents/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/documents/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/documents/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`recordcount`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

QualityNcr

GET /v1/quality/ncr #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/quality/ncr #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityNcrModel

DELETE /v1/quality/ncr/{QualityNcrID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityNcrID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/ncr/{QualityNcrID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityNcrID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/quality/ncr/{QualityNcrID} #

Parameters

Name	In	Type	Required	Details	Description
`QualityNcrID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityNcrModel

PATCH /v1/quality/ncr/{QualityNcrID}/Assignment #

Parameters

Name	In	Type	Required	Details	Description
`QualityNcrID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityNcrModel

PATCH /v1/quality/ncr/{QualityNcrID}/Notes #

Parameters

Name	In	Type	Required	Details	Description
`QualityNcrID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails QualityNcrModel

GET /v1/quality/ncr/search/{search} #

Parameters

Name	In	Type	Required	Details	Description
`search`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/quality/ncr/status/{status} #

Parameters

Name	In	Type	Required	Details	Description
`status`	path	`string`	Yes	default: OPEN

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ReleaseNotes

GET /v1/releasenotes #

Returns all published release-note editions, newest first.

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ReleaseNoteApiModel

GET /v1/releasenotes/{date} #

Returns one published release-note edition by its ISO date.

Parameters

Name	In	Type	Required	Details	Description
`date`	path	`string`	Yes

Responses

200 OK application/json

{
  "date": "example",
  "title": "example",
  "markdown": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ReleaseNoteApiModel

Reports

GET /v1/reports/{Report} #

Parameters

Name	In	Type	Required	Details	Description
`Report`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ResourceGroups

GET /v1/resourcegroups #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/resourcegroups #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceGroupModel ProblemDetails

DELETE /v1/resourcegroups/{ResourceGroupID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceGroupID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/resourcegroups/{ResourceGroupID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceGroupID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/resourcegroups/{ResourceGroupID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceGroupID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceGroupModel ProblemDetails

PATCH /v1/resourcegroups/{ResourceGroupID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`ResourceGroupID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceGroupModel ProblemDetails

GET /v1/resourcegroups/byname/{ResourceGroupName} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceGroupName`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Resources

GET /v1/resources #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/resources #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceModel ProblemDetails

DELETE /v1/resources/{ResourceID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/resources/{ResourceID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/resources/{ResourceID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceModel ProblemDetails

PATCH /v1/resources/{ResourceID}/nonworkingdays #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceModel ProblemDetails

PATCH /v1/resources/{ResourceID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionResourceModel ProblemDetails

GET /v1/resources/byname/{ResourceName} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceName`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Rules

DELETE /v1/{ProductID}/rules/all #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/rules #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID}/rules/export #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/rules #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionRuleModel ProblemDetails

GET /v1/rules/{ProductID}/export #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`RuleID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`RuleID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/rules/{RuleID} #

Parameters

Name	In	Type	Required	Details	Description
`RuleID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionRuleModel ProblemDetails

PUT /v1/rules/batch #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionRuleModel ProblemDetails

GET /v1/rules/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/products/{ProductID}/count #

Get Count by ProductID

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/products/{ProductID}/groups/{RuleGroupID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`RuleGroupID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/search/{number} #

Parameters

Name	In	Type	Required	Details	Description
`number`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Sales Orders

GET /v1/salesorders #

Retrieves all sales orders using the default slicer (SalesOrderSlicerModel).

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 2147483647	Maximum number of records to return. Defaults to `int.MaxValue`.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

POST /v1/salesorders #

Retrieves sales orders using the provided slicer model.

Parameters

Name	In	Type	Required	Details	Description
`Limit`	query	`integer`	No	format: int32 default: 2147483647	Optional maximum number of records to return. Defaults to `int.MaxValue`.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel SalesOrderSlicerModel

PUT /v1/salesorders #

Creates a new Sales Order.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID} #

Deletes the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order to delete.

Responses

400 Bad Request

200 OK text/plain

GET /v1/salesorders/{SalesOrderID} #

Retrieves a single Sales Order by its unique identifier.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order to retrieve. This value is required and must match an existing Sales Order.
`updateattributes`	query	`boolean`	No	default: false	Optional. Indicates whether attribute (display) should be performed. Defaults to `false`. Enable only when the client needs display attributes recalculated.

Responses

400 Bad Request

200 OK text/plain

{
  "instanceID": "example_001",
  "organizationID": "example_001",
  "salesOrderID": "example_001",
  "salesQuoteID": "example_001",
  "billTo": {
    "customerID": "example_001",
    "customerNumber": "example",
    "customerName": "Example name",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example",
    "country": "example"
  },
  "shipTo": {
    "shipToID": "example_001",
    "customerID": "example_001",
    "name": "Example name",
    "number": "example",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example"
  },
  "endCustomer": {
    "endCustomerID": "example_001",
    "customerID": "example_001",
    "name": "Example name",
    "number": "example",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example"
  },
  "contacts": "example"
}

Schemas: SalesOrderModel

PATCH /v1/salesorders/{SalesOrderID}/basics #

Updates the basic fields of the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order to update.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

PUT /v1/salesorders/{SalesOrderID}/changeorders #

Adds a change order entry to the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.

Responses

400 Bad Request

200 OK text/plain

Schemas: ChangeOrderModel

PATCH /v1/salesorders/{SalesOrderID}/customer #

Updates the customer information for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose customer information should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

POST /v1/salesorders/{SalesOrderID}/documents #

Uploads a document for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.

Responses

400 Bad Request

200 OK text/plain

Schemas: DocumentUploadModel

DELETE /v1/salesorders/{SalesOrderID}/documents/{DocumentID} #

Deletes a document from the specified Sales Order and removes the associated file(s).

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.
`DocumentID`	path	`string`	Yes		The unique identifier of the document to delete.

Responses

400 Bad Request

200 OK text/plain

GET /v1/salesorders/{SalesOrderID}/documents/{DocumentID} #

Retrieves a stored document for the specified Sales Order and streams it to the client.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.
`DocumentID`	path	`string`	Yes		The unique identifier of the document.

Responses

400 Bad Request

200 OK text/plain

"example"

POST /v1/salesorders/{SalesOrderID}/email #

Sends a Sales Order as a PDF email to a specified person.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order to email.
`PersonID`	query	`string`	No		The unique identifier of the recipient person.
`Format`	query	`string`	No	default: pdf	The output format (default: "pdf").

Responses

400 Bad Request

200 OK text/plain

Schemas: EmailMessageModel

GET /v1/salesorders/{SalesOrderID}/finishdate #

Retrieves the latest (maximum) planned completion date for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose finish date should be retrieved. This value is required.

Responses

400 Bad Request

200 OK text/plain

"2026-01-15T12:00:00Z"

PATCH /v1/salesorders/{SalesOrderID}/history #

Updates the history entries for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose history should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

PATCH /v1/salesorders/{SalesOrderID}/items #

Updates the item collection for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose items should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID}/items/{itemandqtyid} #

Deletes a specific item from the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.
`itemandqtyid`	path	`string`	Yes		The unique identifier of the item to delete.

Responses

400 Bad Request

200 OK text/plain

PATCH /v1/salesorders/{SalesOrderID}/lineitems #

Updates the line items for the specified Sales Order and synchronizes related Production Orders.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose line items should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID}/lineitems/{lineitemid} #

Deletes a specific line item from the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.
`lineitemid`	path	`string`	Yes		The unique identifier of the line item to delete.

Responses

400 Bad Request

200 OK text/plain

GET /v1/salesorders/{SalesOrderID}/lineitems/{LineItemID}/prodorders #

Retrieves the Production Orders associated with the specified Sales Order and Line Item.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.
`LineItemID`	path	`string`	Yes		The unique identifier of the Line Item.

Responses

400 Bad Request

200 OK text/plain

{
  "instanceID": "example_001",
  "productionOrderID": "example_001",
  "number": "example",
  "productionOrderNumber": "example",
  "parentProductionOrderID": "example_001",
  "status": 0,
  "statusText": "example",
  "sequenceNumber": 0
}

Schemas: ProductionOrderModel

PATCH /v1/salesorders/{SalesOrderID}/notes #

Updates the notes for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose notes should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

PUT /v1/salesorders/{SalesOrderID}/notes #

Adds a note to the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order.

Responses

400 Bad Request

200 OK text/plain

Schemas: NoteModel

GET /v1/salesorders/{SalesOrderID}/pdf #

Generates a PDF for the specified Sales Order using the provided template.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order to render as a PDF.
`DocumentID`	query	`string`	No		Optional template DocumentID. If omitted or invalid, the default Sales Order template is used.

Responses

400 Bad Request

200 OK application/pdf

"example"

GET /v1/salesorders/{SalesOrderID}/public/url #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

400 Bad Request

PATCH /v1/salesorders/{SalesOrderID}/status #

Updates the status of the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose status should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderStatusUpdateModel

POST /v1/salesorders/{SalesOrderID}/statuscheck #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

400 Bad Request

200 OK text/plain

PATCH /v1/salesorders/{SalesOrderID}/tags #

Updates the tag collection for the specified Sales Order.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes		The unique identifier of the Sales Order whose tags should be updated.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderModel

GET /v1/salesorders/analysis/configurations #

Retrieves configuration analysis results for the specified Product ID.

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	query	`string`	No		The unique identifier of the product whose configuration analysis should be retrieved.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: ConfigurationAnalysisMonthModel

POST /v1/salesorders/analysis/createdon #

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: RecordTextIntegerModel SalesOrderSlicerModel

POST /v1/salesorders/analysis/status #

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: RecordTextIntegerModel SalesOrderSlicerModel

GET /v1/salesorders/bycustomer/{CustomerID} #

Retrieves all Sales Orders associated with the specified Customer ID.

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes		The unique identifier of the customer whose Sales Orders should be retrieved. This value is required.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

POST /v1/salesorders/byids #

Retrieves multiple Sales Orders by their unique identifiers.

Parameters

Name	In	Type	Required	Details	Description
`updateattributes`	query	`boolean`	No	default: false	Optional. Indicates whether attribute hydration should be performed for each returned Sales Order. Defaults to `false`.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

GET /v1/salesorders/byquoteid/{SalesQuoteID} #

Retrieves the Sales Order associated with the specified Sales Quote ID.

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes		The unique identifier of the Sales Quote whose Sales Order should be retrieved. This value is required.

Responses

400 Bad Request

200 OK text/plain

{
  "instanceID": "example_001",
  "organizationID": "example_001",
  "salesOrderID": "example_001",
  "salesQuoteID": "example_001",
  "billTo": {
    "customerID": "example_001",
    "customerNumber": "example",
    "customerName": "Example name",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example",
    "country": "example"
  },
  "shipTo": {
    "shipToID": "example_001",
    "customerID": "example_001",
    "name": "Example name",
    "number": "example",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example"
  },
  "endCustomer": {
    "endCustomerID": "example_001",
    "customerID": "example_001",
    "name": "Example name",
    "number": "example",
    "address": "example",
    "city": "example",
    "state": "example",
    "postalCode": "example"
  },
  "contacts": "example"
}

Schemas: SalesOrderModel

POST /v1/salesorders/count #

Retrieves the count of Sales Orders matching the provided slicer criteria.

Responses

400 Bad Request

200 OK text/plain

Schemas: SalesOrderSlicerModel

PATCH /v1/salesorders/createdby #

Updates the "Created By" user information for one or more Sales Orders.

Responses

400 Bad Request

200 OK text/plain

Schemas: UpdateCreatedByModel

GET /v1/salesorders/createdby/{UserID} #

Retrieves all Sales Orders created by the specified user.

Parameters

Name	In	Type	Required	Details	Description
`UserID`	path	`string`	Yes		The unique identifier of the user whose created Sales Orders should be retrieved. This value is required.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

GET /v1/salesorders/customers #

Retrieves all customers that have associated Sales Orders.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: CustomerModel

GET /v1/salesorders/dayselapsed/max #

Retrieves the maximum `DaysElapsed` value across all Sales Orders.

This endpoint is typically used by UI components that need to compute dynamic range filters or determine the upper bound for elapsed‑day visualizations.

Responses

400 Bad Request

200 OK text/plain

GET /v1/salesorders/export/lineitems #

Responses

400 Bad Request

200 OK text/plain

"example"

POST /v1/salesorders/export/lineitems #

Exports all Sales Order line items as a CSV file.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderSlicerModel

GET /v1/salesorders/export/profitability #

Parameters

Name	In	Type	Required	Details
`from`	query	`string`	No	format: date-time
`to`	query	`string`	No	format: date-time
`bundle`	query	`boolean`	No	default: false
`download`	query	`boolean`	No	default: false
`includeLog`	query	`boolean`	No	default: false

Responses

400 Bad Request

200 OK text/plain

{
  "exported": 0,
  "resultFileName": "Example name",
  "resultUrl": "example",
  "logFileName": "Example name",
  "logUrl": "example",
  "calculationLog": "example"
}

Schemas: SalesOrderProfitabilityExportResponseModel

GET /v1/salesorders/export/profitability/download/{fileName} #

Parameters

Name	In	Type	Required	Details	Description
`fileName`	path	`string`	Yes

Responses

400 Bad Request

200 OK text/plain

"example"

GET /v1/salesorders/export/summary #

Responses

400 Bad Request

200 OK text/plain

"example"

POST /v1/salesorders/export/summary #

Exports a summary of Sales Orders as a CSV file.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderSlicerModel

GET /v1/salesorders/export/xml #

Exports the specified XML template used for Sales Order processing.

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	query	`string`	No		The unique identifier of the XML template.

Responses

400 Bad Request

200 OK text/plain

"example"

POST /v1/salesorders/finishdates #

Retrieves the finish dates for the specified list of Sales Order IDs.

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderIDs`	query	`array of string`	No		A list of Sales Order IDs for which finish dates should be retrieved. This value is required and must contain at least one ID.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderFinishDateModel

POST /v1/salesorders/import #

Imports Sales Orders from an uploaded file.

Responses

400 Bad Request

200 OK text/plain

{
  "importID": "example_001",
  "messages": "example",
  "errors": "example",
  "status": "example",
  "linesProcessed": 0,
  "fileName": "Example name",
  "timeRequired": 0,
  "created": 0
}

Schemas: ImportResultModel

GET /v1/salesorders/import/results #

Retrieves the most recent import results for Sales Orders.

Responses

400 Bad Request

200 OK text/plain

{
  "importID": "example_001",
  "messages": "example",
  "errors": "example",
  "status": "example",
  "linesProcessed": 0,
  "fileName": "Example name",
  "timeRequired": 0,
  "created": 0
}

Schemas: ImportResultModel

GET /v1/salesorders/mtd #

Retrieves all Sales Orders created or updated Month‑To‑Date (MTD).

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

POST /v1/salesorders/pages/{page} #

Retrieves a paged list of Sales Orders using the provided slicer and paging parameters.

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32	The page number to retrieve. Must be `>= 1`.
`RecordsPerPage`	query	`integer`	No	format: int32	The number of records per page. Must be `>= 1`.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel SalesOrderSlicerModel

GET /v1/salesorders/public/validate #

Validates a public Sales Order key.

Parameters

Name	In	Type	Required	Details	Description
`key`	query	`string`	No		The public key to validate.

Responses

400 Bad Request

200 OK text/plain

false

GET /v1/salesorders/schedule #

Retrieves all Sales Order work items, including associated Production Orders, grouped and sequenced for scheduling.

This endpoint returns the same data as `Schedule` and is used by the Velosity scheduling engine to build work queues.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderWorkModel

GET /v1/salesorders/search/{ordernumber} #

Searches for Sales Orders whose order number matches or partially matches the provided value.

Parameters

Name	In	Type	Required	Details	Description
`ordernumber`	path	`string`	Yes		The order number or partial order number to search for.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

POST /v1/salesorders/sla #

Returns a slim SLA report for Sales Orders matching the slicer, computing the SLA ceiling using the hierarchy: Product Standard Leadtime -> Product Max Days -> Customer Max Days.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderSlaModel SalesOrderSlicerModel

GET /v1/salesorders/statemachines/status #

Retrieves the Sales Order Status state machine definition.

Returns the full state machine graph used by Velosity to validate and transition Sales Order status values. The response includes states, transitions, and metadata suitable for visualization or workflow validation.

Responses

400 Bad Request

200 OK text/plain

{
  "mermaid": "example_001"
}

Schemas: StateMachineDiagramModel

GET /v1/salesorders/status/{Status}/allowed #

Retrieves the list of allowed next statuses for a given Sales Order status.

Parameters

Name	In	Type	Required	Details	Description
`Status`	path	`string`	Yes		The current Sales Order status. Must be a valid status value defined in Velosity.Sales.SalesOrderModel.

Responses

400 Bad Request

200 OK text/plain

"example"

GET /v1/salesorders/status/check #

Triggers an asynchronous Sales Order status check operation.

Responses

400 Bad Request

200 OK text/plain

GET /v1/salesorders/work #

Retrieves all Sales Order work items, including associated Production Orders, grouped and sequenced for scheduling.

This endpoint returns the same data as `Schedule` and is used by the Velosity scheduling engine to build work queues.

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderWorkModel

GET /v1/salesorders/ytd #

Retrieves all Sales Orders created or updated Year‑To‑Date (YTD).

Responses

400 Bad Request

200 OK text/plain

"example"

Schemas: SalesOrderModel

SalesOpportunities

GET /v1/salesfunnel #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/salesfunnel #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityModel

DELETE /v1/salesfunnel/{OpportunityID} #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesfunnel/{OpportunityID} #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesfunnel/{OpportunityID} #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityModel

PATCH /v1/salesfunnel/{OpportunityID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityModel

PUT /v1/salesfunnel/{OpportunityID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: NoteModel ProblemDetails

PATCH /v1/salesfunnel/{OpportunityID}/people #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityModel

PUT /v1/salesfunnel/{OpportunityID}/sendemail #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

Schemas: EmailMessageModel

PATCH /v1/salesfunnel/{OpportunityID}/tags #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityModel

GET /v1/salesfunnel/count #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`SalesOpportunityStatus`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityStatus

GET /v1/salesfunnel/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesfunnel/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`SalesOpportunityStatus`	No
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesOpportunityStatus

GET /v1/salesfunnel/people #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesfunnel/search/{SearchString} #

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/salesfunnel/sendtouser #

Parameters

Name	In	Type	Required	Details	Description
`OpportunityID`	query	`string`	No

Responses

200 OK

Schemas: NotificationModel

GET /v1/salesfunnel/totals #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

SalesOrderProductionComparison

GET /v1/salesorders/{salesOrderID}/analysis/production-comparison #

Parameters

Name	In	Type	Required	Details	Description
`salesOrderID`	path	`string`	Yes

Responses

200 OK

POST /v1/salesorders/{salesOrderID}/analysis/production-comparison/generate #

Parameters

Name	In	Type	Required	Details	Description
`salesOrderID`	path	`string`	Yes

Responses

200 OK

POST /v1/salesorders/analysis/production-comparisons #

Responses

200 OK

Schemas: SalesOrderProductionComparisonSlicerModel

PUT /v1/salesorders/analysis/production-comparisons #

Responses

200 OK

Schemas: SalesOrderProductionComparisonModel

DELETE /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

Name	In	Type	Required	Details	Description
`id`	path	`string`	Yes

Responses

200 OK

GET /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

Name	In	Type	Required	Details	Description
`id`	path	`string`	Yes

Responses

200 OK

PATCH /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

Name	In	Type	Required	Details	Description
`id`	path	`string`	Yes

Responses

200 OK

Schemas: SalesOrderProductionComparisonModel

POST /v1/salesorders/analysis/production-comparisons/count #

Responses

200 OK

Schemas: SalesOrderProductionComparisonSlicerModel

POST /v1/salesorders/analysis/production-comparisons/generate-all #

Responses

200 OK

GET /v1/salesorders/analysis/production-comparisons/generate-all/{jobID} #

Parameters

Name	In	Type	Required	Details	Description
`jobID`	path	`string`	Yes

Responses

200 OK

SalesQuoteEmailLog

GET /v1/salesquotes/logs/email #

Parameters

Name	In	Type	Required	Details	Description
`count`	query	`integer`	No	format: int32 default: 50

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/salesquotes/logs/email #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteEmailLogModel

GET /v1/salesquotes/logs/email/{LogID} #

Parameters

Name	In	Type	Required	Details	Description
`LogID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

SalesQuotes

GET /v1/salesquotes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

PUT /v1/salesquotes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

DELETE /v1/salesquotes/{SalesQuoteID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/basics #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

GET /v1/salesquotes/{SalesQuoteID}/cancel #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/customer #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PATCH /v1/salesquotes/{SalesQuoteID}/delivery/update/{DeliveryOptionID} #

Update Delivery

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`DeliveryOptionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/discount #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

POST /v1/salesquotes/{SalesQuoteID}/documents #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DocumentUploadModel ProblemDetails

DELETE /v1/salesquotes/{SalesQuoteID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/documents/{DocumentID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`DocumentID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/{SalesQuoteID}/email/checkout #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/{SalesQuoteID}/email/link #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/{SalesQuoteID}/email/pdf #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`PersonID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EmailMessageModel ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/history #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PATCH /v1/salesquotes/{SalesQuoteID}/items #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PUT /v1/salesquotes/{SalesQuoteID}/items #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemAndQtyModel ProblemDetails

DELETE /v1/salesquotes/{SalesQuoteID}/items/{itemandqtyid} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`itemandqtyid`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/lineitems #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PUT /v1/salesquotes/{SalesQuoteID}/lineitems #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: LineItemModel ProblemDetails

DELETE /v1/salesquotes/{SalesQuoteID}/lineitems/{lineitemid} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`lineitemid`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/lineitems/{LineItemID}/export/bom #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`LineItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/lineitems/{LineItemID}/export/router #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`LineItemID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/linenumbering #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PATCH /v1/salesquotes/{SalesQuoteID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PUT /v1/salesquotes/{SalesQuoteID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: NoteModel ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/payment #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

POST /v1/salesquotes/{SalesQuoteID}/payment/cc #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`key`	query	`string`	No

Responses

200 OK application/json

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

409 Conflict application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuotePaymentTokenRequestModel

POST /v1/salesquotes/{SalesQuoteID}/payment/clear #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

Schemas: PurchaseOrderPaymentUploadModel

POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/approve #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK application/json

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

403 Forbidden application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/pdf #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/reject #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK application/json

POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/upload #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`key`	query	`string`	No

Responses

200 OK

Schemas: PurchaseOrderPaymentUploadModel

POST /v1/salesquotes/{SalesQuoteID}/payment/test/{Outcome} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`Outcome`	path	`string`	Yes

Responses

200 OK application/json

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

403 Forbidden application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/pdf #

Parameters

Name	In	Type	Required
`SalesQuoteID`	path	`string`	Yes
`DocumentID`	query	`string`	No
`Preview`	query	`string`	No
`key`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/pdf/validate #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`DocumentID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/phase #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuotePhaseUpdateModel

GET /v1/salesquotes/{SalesQuoteID}/public/url #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/status #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteStatusUpdateModel

PATCH /v1/salesquotes/{SalesQuoteID}/status/historical #

Applies an administrator-reviewed status normalization to a legacy quote. Unlike the regular status endpoint, this endpoint has no lifecycle side effects.

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

403 Forbidden application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteStatusUpdateModel

PATCH /v1/salesquotes/{SalesQuoteID}/tags #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteModel

PATCH /v1/salesquotes/{SalesQuoteID}/validity #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteUpdateValidityModel

GET /v1/salesquotes/{SalesQuoteID}/versions/{VersionNumber} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`VersionNumber`	path	`integer`	Yes	format: int32

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/analysis/createdby #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RecordTextIntegerModel SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/createdon #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RecordTextIntegerModel SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/lines #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteAnalysisLineModel SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/phase #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RecordTextIntegerModel SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/status #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RecordTextIntegerModel SalesQuoteSlicerModel

GET /v1/salesquotes/bycustomer/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/byids #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/bysalesorder/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

PATCH /v1/salesquotes/createdby #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails UpdateCreatedByModel

GET /v1/salesquotes/createdby/{UserID} #

Parameters

Name	In	Type	Required	Details	Description
`UserID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/customers #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/export/lineitems #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/export/lineitems #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

GET /v1/salesquotes/export/summary #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/export/summary #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

POST /v1/salesquotes/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/index/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK application/json

{
  "salesQuotes": "example",
  "customers": "example",
  "totalRecords": 0
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteIndexPageModel SalesQuoteSlicerModel

GET /v1/salesquotes/mtd #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/notinfunnel #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/pages/{page} #

Get Quotes As Pages ?filter=MY, ALL ?status=DRAFT, etc

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

POST /v1/salesquotes/pages/{page}/customers #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: CustomerModel ProblemDetails SalesQuoteSlicerModel

GET /v1/salesquotes/public/checkout #

Parameters

Name	In	Type	Required	Details	Description
`key`	query	`string`	No

Responses

200 OK

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/public/validate #

Parameters

Name	In	Type	Required	Details	Description
`key`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/recent #

Get Quotes - Recent

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 5

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSlicerModel

GET /v1/salesquotes/search/{quotenumber} #

Parameters

Name	In	Type	Required	Details	Description
`quotenumber`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/statemachines/payment #

Responses

200 OK application/json

{
  "mermaid": "example_001"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails StateMachineDiagramModel

GET /v1/salesquotes/statemachines/status #

Retrieves the Sales Quote Status state machine definition.

Responses

200 OK application/json

{
  "mermaid": "example_001"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails StateMachineDiagramModel

GET /v1/salesquotes/ytd #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

SalesQuotesAnalysis

POST /v1/salesquotes/analysis/aging #

Responses

200 OK

Schemas: SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/conversion #

Responses

200 OK

Schemas: SalesQuoteSlicerModel

POST /v1/salesquotes/analysis/customers #

Responses

200 OK application/json

{
  "records": "example",
  "heatMapData": "example",
  "xLabels": "example",
  "yLabels": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuotesAnalysisCustomersModel SalesQuoteSlicerModel

SalesQuoteSimulations

GET /v1/salesquotes/{SalesQuoteID}/simulations #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/salesquotes/{SalesQuoteID}/simulations #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSimulationModel

GET /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`SimulationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`SimulationID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteSimulationModel

Schedule

GET /v1/schedule #

Responses

200 OK

POST /v1/schedule #

Responses

200 OK

Schemas: ScheduleSlicerModel

GET /v1/schedule/assigned/{ResourceID} #

Parameters

Name	In	Type	Required	Details	Description
`ResourceID`	path	`string`	Yes

Responses

200 OK

GET /v1/schedule/build #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/schedule/count #

Responses

200 OK

POST /v1/schedule/count #

Responses

200 OK

Schemas: ScheduleSlicerModel

GET /v1/schedule/customers #

Responses

200 OK

GET /v1/schedule/customers/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

POST /v1/schedule/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleSlicerModel

GET /v1/schedule/first #

Responses

200 OK

GET /v1/schedule/last #

Responses

200 OK

GET /v1/schedule/materials #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No

Responses

200 OK

GET /v1/schedule/materials/{RequestID} #

Parameters

Name	In	Type	Required	Details	Description
`RequestID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/schedule/materials/{RequestID} #

Parameters

Name	In	Type	Required	Details	Description
`RequestID`	path	`string`	Yes

Responses

200 OK

Schemas: ProductionOrderMaterialsRequestModel

GET /v1/schedule/materials/days/{Days} #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No
`Days`	path	`integer`	Yes	format: int32 default: 0

Responses

200 OK

POST /v1/schedule/monitor #

Responses

200 OK

Schemas: ScheduleSlicerModel

GET /v1/schedule/month #

Parameters

Name	In	Type	Required	Details
`ViewBy`	query	`string`	No
`Year`	query	`integer`	No	format: int32
`MonthNum`	query	`integer`	No	format: int32

Responses

200 OK

POST /v1/schedule/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32

Responses

200 OK

Schemas: ScheduleSlicerModel

POST /v1/schedule/queues/export #

Parameters

Name	In	Type	Required	Details	Description
`Format`	query	`string`	No	default: csv

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleSlicerModel

GET /v1/schedule/queues/search/{searchfor} #

Parameters

Name	In	Type	Required	Details	Description
`searchfor`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/schedule/queues/utilization/export #

Parameters

Name	In	Type	Required	Details	Description
`Format`	query	`string`	No	default: csv

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleSlicerModel

GET /v1/schedule/resources/queues #

Responses

200 OK

GET /v1/schedule/resources/queues/{QueueName} #

Parameters

Name	In	Type	Required	Details	Description
`QueueName`	path	`string`	Yes

Responses

200 OK

GET /v1/schedule/results/last/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/schedule/results/last/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`Page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/schedule/salesorders #

Responses

200 OK

GET /v1/schedule/search #

Parameters

Name	In	Type	Required	Details	Description
`q`	query	`string`	No

Responses

200 OK

GET /v1/schedule/tasks/queues #

Parameters

Name	In	Type	Required	Details	Description
`LocationID`	query	`string`	No

Responses

200 OK

GET /v1/schedule/tasks/queues/{QueueName} #

Parameters

Name	In	Type	Required	Details	Description
`QueueName`	path	`string`	Yes

Responses

200 OK

GET /v1/schedule/users/assigned #

Responses

200 OK

ScheduleResequenceRequests

GET /v1/prodorders/{ProductionOrderID}/resequence/request #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/schedule/resequence/requests #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/schedule/resequence/requests #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestModel

DELETE /v1/schedule/resequence/requests/{RequestID} #

Parameters

Name	In	Type	Required	Details	Description
`RequestID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/schedule/resequence/requests/{RequestID} #

Parameters

Name	In	Type	Required	Details	Description
`RequestID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/schedule/resequence/requests/{RequestID} #

Parameters

Name	In	Type	Required	Details	Description
`RequestID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestModel

POST /v1/schedule/resequence/requests/all #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestSlicerModel

POST /v1/schedule/resequence/requests/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestSlicerModel

POST /v1/schedule/resequence/requests/create #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestModel

POST /v1/schedule/resequence/requests/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestSlicerModel

Search

POST /v1/search #

Responses

200 OK application/json

{
  "serviceTickets": "example",
  "serials": "example",
  "salesQuotes": "example",
  "salesOrders": "example",
  "customers": "example",
  "productionOrders": "example",
  "items": "example",
  "itemCompatibilities": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: GlobalSearchRequestModel GlobalSearchResultModel ProblemDetails

POST /v1/search/lite-customer-items #

Responses

200 OK application/json

{
  "serviceTickets": "example",
  "serials": "example",
  "salesQuotes": "example",
  "salesOrders": "example",
  "customers": "example",
  "productionOrders": "example",
  "items": "example",
  "itemCompatibilities": "example"
}

Schemas: GlobalSearchLiteResultModel GlobalSearchRequestModel

Serialization

GET /v1/serialization #

Responses

200 OK

PUT /v1/serialization #

Responses

200 OK

Schemas: SerializationSerialNumberModel

DELETE /v1/serialization/{SerialID} #

Parameters

Name	In	Type	Required	Details	Description
`SerialID`	path	`string`	Yes

Responses

200 OK

GET /v1/serialization/{SerialID} #

Parameters

Name	In	Type	Required	Details	Description
`SerialID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/serialization/{SerialID} #

Parameters

Name	In	Type	Required	Details	Description
`SerialID`	path	`string`	Yes

Responses

200 OK

Schemas: SerializationSerialNumberModel

PATCH /v1/serialization/{SerialID}/batch #

Parameters

Name	In	Type	Required	Details	Description
`SerialID`	path	`string`	Yes

Responses

200 OK

Schemas: SerializationSerialNumberModel

PUT /v1/serialization/batch #

Responses

200 OK

Schemas: SerializationSerialNumberModel

GET /v1/serialization/count #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No

Responses

200 OK

GET /v1/serialization/customers/{CustomerID} #

Parameters

Name	In	Type	Required	Details	Description
`CustomerID`	path	`string`	Yes

Responses

200 OK

GET /v1/serialization/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/serialization/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: FileUploadModel ProblemDetails

GET /v1/serialization/import/results #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/serialization/pages/{page} #

Parameters

Name	In	Type	Required	Details
`page`	path	`integer`	Yes	format: int32
`Status`	query	`string`	No
`limit`	query	`integer`	No	format: int32

Responses

200 OK

GET /v1/serialization/search/{SearchString} #

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

ServiceCodes

GET /v1/service/codes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/service/codes #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ServiceCodeModel

DELETE /v1/service/codes/{CodeID} #

Parameters

Name	In	Type	Required	Details	Description
`CodeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/codes/{CodeID} #

Parameters

Name	In	Type	Required	Details	Description
`CodeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/service/codes/{CodeID} #

Parameters

Name	In	Type	Required	Details	Description
`CodeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ServiceCodeModel

GET /v1/service/codes/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ServiceRepairTemplates

GET /v1/service/repairsummary/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/service/repairsummary/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RepairSummaryTemplateModel

DELETE /v1/service/repairsummary/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/repairsummary/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/service/repairsummary/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails RepairSummaryTemplateModel

ServiceTickets

GET /v1/service/tickets #

Responses

200 OK

PUT /v1/service/tickets #

Responses

200 OK

Schemas: ServiceTicketModel

DELETE /v1/service/tickets/{TicketID} #

Parameters

Name	In	Type	Required	Details	Description
`TicketID`	path	`string`	Yes

Responses

200 OK

GET /v1/service/tickets/{TicketID} #

Parameters

Name	In	Type	Required	Details	Description
`TicketID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/service/tickets/{TicketID} #

Parameters

Name	In	Type	Required	Details	Description
`TicketID`	path	`string`	Yes

Responses

200 OK

Schemas: ServiceTicketModel

PUT /v1/service/tickets/batch #

Responses

200 OK

Schemas: ServiceTicketModel

GET /v1/service/tickets/by/salesorderid/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes

Responses

200 OK

GET /v1/service/tickets/by/salesquoteid/{SalesQuoteID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes

Responses

200 OK

GET /v1/service/tickets/count #

Responses

200 OK

GET /v1/service/tickets/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/service/tickets/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/tickets/import/results #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/tickets/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1
`limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

POST /v1/service/tickets/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1
`limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

Schemas: ServiceTicketSlicerModel

GET /v1/service/tickets/search/{q} #

Parameters

Name	In	Type	Required	Details	Description
`q`	path	`string`	Yes
`limit`	query	`integer`	No	format: int32 default: 2147483647

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

SmartQuoteCopilot

POST /v1/setup/smartquote/copilot #

Responses

200 OK

GET /v1/setup/smartquote/copilot/status/{jobId} #

Parameters

Name	In	Type	Required	Details	Description
`jobId`	path	`string`	Yes

Responses

200 OK

SmartQuoteVersions

GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`ProductID`	path	`string`	Yes

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SmartQuoteVersionModel

POST /v1/instances/{InstanceID}/smartquote/{ProductID}/versions #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`ProductID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SmartQuoteVersionModel

GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID} #

Parameters

Name	In	Type	Required
`InstanceID`	path	`string`	Yes
`ProductID`	path	`string`	Yes
`VersionID`	path	`string`	Yes

Responses

200 OK application/json

{
  "versionID": "example_001",
  "productID": "example_001",
  "label": "example",
  "state": "example",
  "isReleased": false,
  "attributesJSON": "example",
  "rulesJSON": "example",
  "ruleGroupsJSON": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SmartQuoteVersionModel

PATCH /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID}/state #

Parameters

Name	In	Type	Required
`InstanceID`	path	`string`	Yes
`ProductID`	path	`string`	Yes
`VersionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SmartQuoteVersionStateUpdateModel

GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/released #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes
`ProductID`	path	`string`	Yes

Responses

200 OK application/json

{
  "versionID": "example_001",
  "productID": "example_001",
  "label": "example",
  "state": "example",
  "isReleased": false,
  "attributesJSON": "example",
  "rulesJSON": "example",
  "ruleGroupsJSON": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SmartQuoteVersionModel

States

GET /v1/setup/countries/{CountryID}/subdivisions #

Parameters

Name	In	Type	Required	Details	Description
`CountryID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/setup/states #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Store

GET /v1/stores/{InstanceID}/themes #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK application/json

"example"

Schemas: StoreThemeModel

POST /v1/stores/{InstanceID}/themes #

Parameters

Name	In	Type	Required	Details	Description
`InstanceID`	path	`string`	Yes

Responses

200 OK

Schemas: StoreThemeModel

GET /v1/stores/{InstanceID}/themes/{ThemeName}/templates/{TemplateName} #

Parameters

Name	In	Type	Required
`InstanceID`	path	`string`	Yes
`ThemeName`	path	`string`	Yes
`TemplateName`	path	`string`	Yes

Responses

200 OK application/json

{
  "themeID": "example_001",
  "storeID": "example_001",
  "name": "Example name",
  "description": "example",
  "themeName": "Example name",
  "templateName": "Example name",
  "lastUpdatedUTC": "2026-01-15T12:00:00Z",
  "settings": "example"
}

Schemas: StoreThemeModel

Suppliers

GET /v1/suppliers #

Get All

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/suppliers #

Add

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

DELETE /v1/suppliers/{SupplierID} #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/{SupplierID} #

Get by SupplierID

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/suppliers/{SupplierID}/basics #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

GET /v1/suppliers/{SupplierID}/itemmapping #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/suppliers/{SupplierID}/itemmapping #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierProductImportMappingModel

POST /v1/suppliers/{SupplierID}/items/import #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/suppliers/{SupplierID}/notes #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

PATCH /v1/suppliers/{SupplierID}/people #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

GET /v1/suppliers/{SupplierID}/pricingupdate/send #

Parameters

Name	In	Type	Required	Details	Description
`SupplierID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/ByNumber/{SupplierNumber} #

Get by SupplierNumber

Parameters

Name	In	Type	Required	Details	Description
`SupplierNumber`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/count #

Get Count

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/suppliers/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/import/results #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/pages/{page} #

Get Pages

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/suppliers/search/{SearchString} #

Get by SupplierName

Parameters

Name	In	Type	Required	Details	Description
`SearchString`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Tasks

GET /v1/tasks #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/tasks #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionTaskModel ProblemDetails

DELETE /v1/tasks/{TaskID} #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/{TaskID} #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/tasks/{TaskID} #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionTaskModel ProblemDetails

PATCH /v1/tasks/{TaskID}/invitations #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionTaskModel ProblemDetails

PATCH /v1/tasks/{TaskID}/model/cost #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TaskModelUpdateModel

PATCH /v1/tasks/{TaskID}/model/time #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TaskModelUpdateModel

PATCH /v1/tasks/{TaskID}/nesting #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionTaskModel ProblemDetails

PATCH /v1/tasks/{TaskID}/nonworkingdays #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: DefinitionTaskModel ProblemDetails

GET /v1/tasks/{TaskID}/references/rules #

Parameters

Name	In	Type	Required	Details	Description
`TaskID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/byname/{TaskName} #

Parameters

Name	In	Type	Required	Details	Description
`TaskName`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/tasks/copyto/{TargetInstanceID} #

Parameters

Name	In	Type	Required	Details	Description
`TargetInstanceID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/tasks/import #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/numbers/next #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/renumber #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/search/{number} #

Parameters

Name	In	Type	Required	Details	Description
`number`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Teams

GET /v1/teams #

Responses

200 OK text/plain

"example"

Schemas: TeamModel

POST /v1/teams #

Responses

200 OK

Schemas: TeamModel

DELETE /v1/teams/{TeamID} #

Parameters

Name	In	Type	Required	Details	Description
`TeamID`	path	`string`	Yes

Responses

200 OK

GET /v1/teams/{TeamID} #

Parameters

Name	In	Type	Required	Details	Description
`TeamID`	path	`string`	Yes

Responses

200 OK text/plain

{
  "teamID": "example_001",
  "name": "Example name",
  "description": "example",
  "isActive": "example",
  "members": "example",
  "notes": "example",
  "createdByUserID": "example_001",
  "createdUTC": "2026-01-15T12:00:00Z"
}

Schemas: TeamModel

PUT /v1/teams/{TeamID} #

Parameters

Name	In	Type	Required	Details	Description
`TeamID`	path	`string`	Yes

Responses

200 OK

Schemas: TeamModel

POST /v1/teams/{TeamID}/members #

Parameters

Name	In	Type	Required	Details	Description
`TeamID`	path	`string`	Yes

Responses

200 OK

Schemas: TeamMemberModel

DELETE /v1/teams/{TeamID}/members/{UserID} #

Parameters

Name	In	Type	Required	Details	Description
`TeamID`	path	`string`	Yes
`UserID`	path	`string`	Yes

Responses

200 OK

GET /v1/teams/my #

Responses

200 OK text/plain

"example"

Schemas: TeamModel

TenantProvisioning

POST /v1/tenant-provisioning #

Responses

200 OK application/json

{
  "tenantID": "example_001",
  "status": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TenantProvisioningRequest TenantProvisioningResponse

GET /v1/tenant-provisioning/{tenantId} #

Parameters

Name	In	Type	Required	Details	Description
`tenantId`	path	`string`	Yes

Responses

200 OK application/json

{
  "tenantID": "example_001",
  "status": "example",
  "lastError": "example",
  "steps": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TenantProvisioningStatusModel

POST /v1/tenants/{tenantId}/seed-runs #

Parameters

Name	In	Type	Required	Details	Description
`tenantId`	path	`string`	Yes

Responses

200 OK application/json

{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "status": "example"
}

400 Bad Request application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TenantSeedRequest TenantSeedResponse

GET /v1/tenants/{tenantId}/seed-runs/{runId} #

Parameters

Name	In	Type	Required	Details	Description
`tenantId`	path	`string`	Yes
`runId`	path	`string`	Yes

Responses

200 OK application/json

{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "status": "example",
  "error": "example"
}

Schemas: TenantSeedRunStatusModel

Timezones

GET /v1/setup/timezones #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ToDo

GET /v1/todo #

Parameters

Name	In	Type	Required	Details	Description
`ReferenceType`	query	`string`	No
`Status`	query	`integer`	No	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/todo #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ToDoModel

PUT /v1/todo #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ToDoModel

GET /v1/todo/{ToDoID} #

Parameters

Name	In	Type	Required	Details	Description
`ToDoID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/todo/export #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/todo/products/{ProductID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`Status`	query	`integer`	No	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/todo/roles/{role} #

Parameters

Name	In	Type	Required	Details
`ReferenceType`	query	`string`	No
`Role`	path	`string`	Yes
`Status`	query	`integer`	No	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/todo/salesorders/{SalesOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesOrderID`	path	`string`	Yes
`Status`	query	`integer`	No	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/todo/salesquotes/{SalesQuoteID} #

Parameters

Name	In	Type	Required	Details	Description
`SalesQuoteID`	path	`string`	Yes
`Status`	query	`integer`	No	format: int32 default: 1

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/todo/todo/{ToDoID} #

Parameters

Name	In	Type	Required	Details	Description
`ToDoID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Tours

GET /v1/tours/{TourID} #

Parameters

Name	In	Type	Required	Details	Description
`TourID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/tours/{TourID} #

Parameters

Name	In	Type	Required	Details	Description
`TourID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails UserTourModel

TroubleReports

PATCH /v1/service/reports/createdby #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails UpdateCreatedByModel

GET /v1/service/troublereports #

Responses

200 OK

PUT /v1/service/troublereports #

Responses

200 OK

Schemas: TroubleReportModel

DELETE /v1/service/troublereports/{ReportID} #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes

Responses

200 OK

GET /v1/service/troublereports/{ReportID} #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes

Responses

200 OK

PATCH /v1/service/troublereports/{ReportID} #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes

Responses

200 OK

Schemas: TroubleReportModel

GET /v1/service/troublereports/{ReportID}/pdf #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes
`DocumentID`	query	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/troublereports/{ReportID}/pdf/validate #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes
`DocumentID`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/service/troublereports/{ReportID}/status #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes

Responses

200 OK

POST /v1/service/troublereports/byids #

Responses

200 OK

POST /v1/service/troublereports/count #

Responses

200 OK

Schemas: TroubleReportSlicerModel

POST /v1/service/troublereports/customers #

Responses

200 OK

Schemas: TroubleReportSlicerModel

POST /v1/service/troublereports/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

Schemas: TroubleReportSlicerModel

POST /v1/service/troublereports/prodorders/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

Schemas: TroubleReportSlicerModel

GET /v1/service/troublereports/productionorder/{ProductionOrderID} #

Parameters

Name	In	Type	Required	Details	Description
`ProductionOrderID`	path	`string`	Yes

Responses

200 OK

POST /v1/service/troublereports/salesorders/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32
`RecordsPerPage`	query	`integer`	No	format: int32

Responses

200 OK

Schemas: TroubleReportSlicerModel

TroubleReportSymptomImages

GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images #

Parameters

Name	In	Type	Required	Details	Description
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} #

Parameters

Name	In	Type	Required
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} #

Parameters

Name	In	Type	Required
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} #

Parameters

Name	In	Type	Required
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ImageModel ProblemDetails

GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}/download #

Parameters

Name	In	Type	Required
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}/replace #

Parameters

Name	In	Type	Required
`ReportID`	path	`string`	Yes
`SymptomID`	path	`string`	Yes
`ImageID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ValidValues

POST /v1/products/{ProductID}/attributes/{AttributeID}/feedback/request #

Parameters

Name	In	Type	Required	Details	Description
`ProductID`	path	`string`	Yes
`AttributeID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: FeedbackRequestParameters ProblemDetails

Verticals

GET /v1/verticals #

Responses

200 OK application/json

"example"

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails VerticalModel

POST /v1/verticals #

Responses

201 Created application/json

{
  "verticalID": "example_001",
  "name": "Example name",
  "targetMarginPercent": 0,
  "isActive": false
}

Schemas: VerticalModel

DELETE /v1/verticals/{VerticalID} #

Parameters

Name	In	Type	Required	Details	Description
`VerticalID`	path	`string`	Yes

Responses

204 No Content

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/verticals/{VerticalID} #

Parameters

Name	In	Type	Required	Details	Description
`VerticalID`	path	`string`	Yes

Responses

200 OK application/json

{
  "verticalID": "example_001",
  "name": "Example name",
  "targetMarginPercent": 0,
  "isActive": false
}

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails VerticalModel

PUT /v1/verticals/{VerticalID} #

Parameters

Name	In	Type	Required	Details	Description
`VerticalID`	path	`string`	Yes

Responses

200 OK application/json

{
  "verticalID": "example_001",
  "name": "Example name",
  "targetMarginPercent": 0,
  "isActive": false
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails VerticalModel

WarehouseMoves

GET /v1/warehouse/moves #

Parameters

Name	In	Type	Required	Details	Description
`Status`	query	`string`	No	default: PENDING

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/warehouse/moves #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: MaterialMovementModel ProblemDetails

PUT /v1/warehouse/moves #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: MaterialMovementModel ProblemDetails

DELETE /v1/warehouse/moves/{MoveID} #

Parameters

Name	In	Type	Required	Details	Description
`MoveID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/warehouse/moves/{MoveID} #

Parameters

Name	In	Type	Required	Details	Description
`MoveID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Webhooks

GET /v1/webhooks #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/webhooks #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WebhookModel

GET /v1/webhooks/{WebhookID} #

Parameters

Name	In	Type	Required	Details	Description
`WebhookID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/webhooks/{WebHookID} #

Parameters

Name	In	Type	Required	Details	Description
`WebHookID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/webhooks/{WebHookID} #

Parameters

Name	In	Type	Required	Details	Description
`WebHookID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WebhookModel

POST /v1/webhooks/{WebhookID}/diagnose #

Parameters

Name	In	Type	Required	Details	Description
`WebhookID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

404 Not Found application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

WebhooksLog

GET /v1/webhooks/log #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/webhooks/logs #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WebhookLogModel

GET /v1/webhooks/logs/count #

Parameters

Name	In	Type	Required	Details	Description
`Entity`	query	`string`	No
`Event`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/webhooks/logs/count #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WebhookLogSlicerModel

POST /v1/webhooks/logs/pages #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WebhookLogSlicerModel

GET /v1/webhooks/logs/pages/{page} #

Parameters

Name	In	Type	Required	Details
`page`	path	`integer`	Yes	format: int32 default: 1
`RecordsPerPage`	query	`integer`	No	format: int32 default: 25
`Entity`	query	`string`	No
`Event`	query	`string`	No

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

WorkInstructions

GET /v1/workinstructions #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/workinstructions #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WorkInstructionModel

DELETE /v1/workinstructions/{InstructionID} #

Parameters

Name	In	Type	Required	Details	Description
`InstructionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/workinstructions/{InstructionID} #

Parameters

Name	In	Type	Required	Details	Description
`InstructionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/workinstructions/{InstructionID} #

Parameters

Name	In	Type	Required	Details	Description
`InstructionID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails WorkInstructionModel

XmlTemplates

GET /v1/xml/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/xml/templates #

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails XmlTemplateModel

DELETE /v1/xml/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/xml/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/xml/templates/{TemplateID} #

Parameters

Name	In	Type	Required	Details	Description
`TemplateID`	path	`string`	Yes

Responses

200 OK

401 Unauthorized application/json

{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails XmlTemplateModel

Schemas

AnnouncementModelobject

Property	Type	Required	Details
`announcementID`	`string`	No	nullable
`message`	`string`	No	nullable
`infoUrl`	`string`	No	nullable
`startDateUTC`	`string`	No	format: date-time
`endDateUTC`	`string`	No	format: date-time nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`appFilter`	`string`	No	nullable
`roleFilter`	`string`	No	nullable
`tenantFilter`	`string`	No	nullable
`isActive`	`boolean`	No

Used by: POST /v1/announcements

AppForgeSettingsModelobject

Property	Type	Required	Details
`strings`	`object`	No	nullable
`terminology`	`ForgeTerminologyModel`	No
`salesOrderSettings`	`SalesOrdersSettingsModel`	No
`salesQuoteSettings`	`SalesQuotesSettingsModel`	No
`generalSettings`	`GeneralSettingsModel`	No
`paymentSettings`	`PaymentSettingsModel`	No
`sftpExport`	`SftpExportSettingsModel`	No
`configurationRelease`	`ConfigurationReleaseSettingsModel`	No
`legacyShowSmartQuoteLinkNav`	`string`	No	nullable
`legacyShowCostAndPricing`	`string`	No	nullable
`legacyShowBillOfMaterials`	`string`	No	nullable
`legacyUsePricingComponents`	`string`	No	nullable
`legacyShowItemDetailInLineItemsTable`	`string`	No	nullable
`legacySalesQuoteAllowSendByEmail`	`string`	No	nullable
`legacyCustomersAllowAdd`	`string`	No	nullable
`legacyItemsAllowAdd`	`string`	No	nullable
`legacySalesQuoteMetaDataLabels`	`array of string`	No	nullable
`legacySalesOrderNumberPrefix`	`string`	No	nullable
`legacySalesQuoteNumberFormat`	`string`	No	nullable
`legacySalesQuoteDefaultPhase`	`string`	No	nullable
`legacySalesFunnelNumberPrefix`	`string`	No	nullable
`legacyTimingApproach`	`string`	No	nullable
`legacySalesOrderPurchaseOrderRequired`	`string`	No	nullable

Used by: POST /v1/instances/{InstanceID}/customization POST /v1/instances/{InstanceID}/settings

ApprovalPolicyModelobject

Property	Type	Required	Details
`policyID`	`string`	No	nullable
`appliesTo`	`string`	No	nullable
`level`	`integer`	No	format: int32
`currencyID`	`string`	No	nullable
`minimum`	`number`	No	format: double
`maximum`	`number`	No	format: double
`role`	`string`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/approval/policies/{PolicyID} POST /v1/approval/policies

AssignmentHistoryModelobject

Property	Type	Required	Details	Description
`userID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

AuditActorTypeinteger

AuditModelobject

Property	Type	Required	Details
`table`	`string`	No	nullable
`field`	`string`	No	nullable
`recordGuid`	`string`	No	nullable
`oldValue`	`string`	No	nullable
`newValue`	`string`	No	nullable
`changedByUserID`	`string`	No	nullable
`changedUTC`	`string`	No	format: date-time

Used by: POST /v1/audit

AuditRecordModelobject

Property	Type	Required	Details
`auditID`	`string`	No	nullable
`primaryKeyID`	`string`	No	nullable
`entity`	`string`	No	nullable
`property`	`string`	No	nullable
`oldValue`	`string`	No	nullable
`newValue`	`string`	No	nullable
`actorType`	`AuditActorType`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

AuditSlicerModelobject

Property	Type	Required	Details	Description
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32

Used by: POST /v1/audit/count POST /v1/audit/pages/{page}

AutomationDesignModelobject

Property	Type	Required	Details
`designID`	`string`	No	nullable
`name`	`string`	No	nullable
`appliesTo`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/automation/designs/{DesignID} POST /v1/automation/designs

AutomationDesignRuleModelobject

Property	Type	Required	Details
`ruleID`	`string`	No	nullable
`designID`	`string`	No	nullable
`name`	`string`	No	nullable
`rule`	`string`	No	nullable
`priority`	`integer`	No	format: int32
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/automation/designs/{DesignID}/rules/{RuleID} POST /v1/automation/designs/{DesignID}/rules

AutomationRunApprovalModelobject

Property	Type	Required	Details	Description
`responses`	`array of string`	No	nullable

AutomationRunDataobject

Property	Type	Required	Details	Description
`timer`	`AutomationRunTimerModel`	No
`approval`	`AutomationRunApprovalModel`	No

AutomationRunModelobject

Property	Type	Required	Details
`runID`	`string`	No	nullable
`designID`	`string`	No	nullable
`state`	`string`	No	nullable
`description`	`string`	No	nullable
`data`	`AutomationRunData`	No
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`errors`	`array of string`	No	nullable
`warnings`	`array of string`	No	nullable
`information`	`array of string`	No	nullable

Used by: PATCH /v1/automation/runs/{RunID} POST /v1/automation/runs

AutomationRunTimerModelobject

Property	Type	Required	Details	Description
`expiresUTC`	`string`	No	format: date-time

BatchBasisinteger

BatchRequirementModelobject

Property	Type	Required	Details
`requirementID`	`string`	No	nullable
`productID`	`string`	No	nullable
`sourceTaskID`	`string`	No	nullable
`sourceTaskName`	`string`	No	nullable
`basis`	`BatchBasis`	No
`quantityUOM`	`string`	No	nullable
`customBasis`	`string`	No	nullable
`attributes`	`object`	No	nullable

CalendarExceptionModelobject

Property	Type	Required	Details
`exceptionID`	`string`	No	nullable
`description`	`string`	No	nullable
`nonWorkingDay`	`string`	No	format: date-time

CatalogLookupDefinitionModelobject

Property	Type	Required	Details
`version`	`integer`	No	format: int32
`return`	`CatalogLookupReturnModel`	No
`filters`	`array of CatalogLookupFilterModel`	No	nullable

CatalogLookupFilterModelobject

Property	Type	Required	Details
`source`	`string`	No	nullable
`field`	`string`	No	nullable
`operator`	`string`	No	nullable
`value`	`string`	No	nullable
`valueFromAttribute`	`string`	No	nullable

CatalogLookupReturnModelobject

Property	Type	Required	Details	Description
`source`	`string`	No	nullable
`field`	`string`	No	nullable

ChangeOrderModelobject

Property	Type	Required	Details
`changeID`	`string`	No	nullable
`description`	`string`	No	nullable
`detail`	`string`	No	nullable
`lineItemID`	`string`	No	nullable
`cost`	`number`	No	format: double
`price`	`number`	No	format: double
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/salesorders/{SalesOrderID}/changeorders

ConfigurationAnalysisCountModelobject

Property	Type	Required	Details
`name`	`string`	No	nullable
`value`	`string`	No	nullable
`count`	`integer`	No	format: int32

ConfigurationAnalysisMonthModelobject

Property	Type	Required	Details	Description
`date`	`string`	No	format: date-time
`attributes`	`array of ConfigurationAnalysisCountModel`	No	nullable

Used by: GET /v1/salesorders/analysis/configurations

ConfigurationAttributeModelobject

Property	Type	Required	Details
`name`	`string`	No	nullable
`value`	`string`	No	nullable
`method`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

ConfigurationModelobject

Property	Type	Required	Details
`configurationID`	`string`	No	nullable
`productID`	`string`	No	nullable
`scheduleEstimate`	`string`	No	nullable
`schedulingPriority`	`string`	No	nullable
`schedulingNotes`	`string`	No	nullable
`attributes`	`object`	No	nullable
`currencyID`	`string`	No	nullable
`currency`	`CurrencyModel`	No
`salesQuoteID`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`options`	`ConfigureOptionsModel`	No

Used by: POST /v1/configure/{ProductID}/configuration PUT /v1/configure/{ProductID}/promotion/create PUT /v1/configure/{ProductID}/salesorders/{SalesOrderID} PUT /v1/configure/{ProductID}/salesquotes/{SalesQuoteID}

ConfigurationReleaseSettingsModelobject

Property	Type	Required
`requireCost`	`boolean`	No
`requirePrice`	`boolean`	No
`requireCurrency`	`boolean`	No
`allowZeroCost`	`boolean`	No
`allowZeroPrice`	`boolean`	No

ConfigureOptionsModelobject

Property	Type	Required	Details
`version`	`string`	No	nullable
`flowMode`	`string`	No	nullable
`onFinishTargetID`	`string`	No	nullable
`onFinishTargetLineItemID`	`string`	No	nullable

CopyToTenantModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`randomizeData`	`string`	No	nullable
`sanitizeData`	`string`	No	nullable

Used by: POST /v1/customers/{CustomerID}/copyinto POST /v1/items/{ItemID}/copyinto POST /v1/products/{ProductID}/copyinto

CurrencyModelobject

Property	Type	Required	Details
`currencyID`	`string`	No	nullable
`country`	`string`	No	nullable
`currency`	`string`	No	nullable
`code`	`string`	No	nullable
`symbol`	`string`	No	nullable
`flagCode`	`string`	No	nullable

CustomerAttributeModelobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`value`	`string`	No	nullable

CustomerBillToModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`customerNumber`	`string`	No	nullable
`customerName`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable
`paymentTerms`	`string`	No	nullable

CustomerCoordinatesModelobject

Property	Type	Required	Details	Description
`latitude`	`number`	No	format: double
`longitude`	`number`	No	format: double

CustomerIncotermModelobject

Property	Type	Required	Details
`termID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`effectiveYear`	`integer`	No	format: int32
`location`	`string`	No	nullable

CustomerMetricsModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`revenueTTM`	`number`	No	format: double
`bookingsTTM`	`number`	No	format: double
`gpPercent`	`number`	No	format: double
`growthRate`	`number`	No	format: double
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/customers/{CustomerID}/metrics

CustomerModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`number`	`string`	No	nullable
`customerNumber`	`string`	No	nullable
`name`	`string`	No	nullable
`customerName`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`coordinates`	`CustomerCoordinatesModel`	No
`geocodeStatus`	`string`	No	nullable
`paymentTerms`	`string`	No	nullable
`grossMarginTarget`	`number`	No	format: double
`maxDaysAllowed`	`integer`	No	format: int32
`region`	`string`	No	nullable
`vertical`	`string`	No	nullable
`source`	`string`	No	nullable
`isPinned`	`boolean`	No
`isActive`	`boolean`	No
`isWebShop`	`boolean`	No
`domain`	`string`	No	nullable
`people`	`array of string`	No	nullable
`incoterm`	`CustomerIncotermModel`	No
`priceBreak`	`CustomerPriceBreakModel`	No
`shipTo`	`array of CustomerShipToModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`attributes`	`array of CustomerAttributeModel`	No	nullable
`lineItemTemplates`	`array of LineItemModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/salesorders/customers PATCH /v1/customers/{CustomerID} PATCH /v1/customers/{CustomerID}/attributes PATCH /v1/customers/batch POST /v1/customers POST /v1/customers/{CustomerID}/templates POST /v1/salesquotes/pages/{page}/customers PUT /v1/customers/batch

CustomerOrderModelobject

Property	Type	Required	Details
`customerOrderID`	`string`	No	nullable
`number`	`string`	No	nullable
`status`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`salesOrderItemAndQtyID`	`string`	No	nullable
`releaseDateUTC`	`string`	No	format: date-time
`lenX`	`integer`	No	format: int32
`widthY`	`integer`	No	format: int32
`heightZ`	`integer`	No	format: int32
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/customerorders/{CustomerOrderID} PUT /v1/customerorders

CustomerPriceBreakModelobject

Property	Type	Required	Details	Description
`priceBreakID`	`string`	No	nullable
`ranges`	`array of CustomerPriceBreakRangeModel`	No	nullable

CustomerPriceBreakRangeModelobject

Property	Type	Required	Details
`rangeID`	`string`	No	nullable
`min`	`number`	No	format: double
`max`	`number`	No	format: double
`discount`	`number`	No	format: double

CustomerSearchModelobject

Fields required to render a customer Global Search result.

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`customerNumber`	`string`	No	nullable
`customerName`	`string`	No	nullable

CustomerShipToModelobject

Property	Type	Required	Details
`shipToID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`name`	`string`	No	nullable
`number`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable
`isActive`	`boolean`	No
`incoterm`	`CustomerIncotermModel`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PUT /v1/customers/{CustomerID}/shipto PUT /v1/customers/{CustomerID}/shipto/batch

CustomersSlicerModelobject

Property	Type	Required	Details
`country`	`string`	No	nullable
`region`	`string`	No	nullable
`vertical`	`string`	No	nullable
`attribute`	`string`	No	nullable
`source`	`string`	No	nullable
`terms`	`string`	No	nullable
`maxDaysAllowed`	`integer`	No	format: int32

Used by: POST /v1/customers/count POST /v1/customers/filter POST /v1/customers/pages/{page}

DashboardEscalationItemModelobject

Property	Type	Required
`escalation`	`ProductionOrderEscalationModel`	No
`productionOrder`	`ProductionOrderModel`	No
`salesOrder`	`SalesOrderModel`	No

DashboardEscalationsResponseobject

Property	Type	Required	Details	Description
`items`	`array of DashboardEscalationItemModel`	No	nullable

Used by: GET /v1/dashboard/escalations

DefinitionAttributeAttrAndValueobject

Property	Type	Required	Details
`pairID`	`string`	No	nullable
`name`	`string`	No	nullable
`value`	`string`	No	nullable

DefinitionAttributeModelobject

Property	Type	Required	Details
`attributeID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`hint`	`string`	No	nullable
`productID`	`string`	No	nullable
`hideWhen`	`string`	No	nullable
`pageID`	`string`	No	nullable
`sequenceNumber`	`integer`	No	format: int32
`dataType`	`string`	No	nullable
`units`	`string`	No	nullable
`validSets`	`array of DefinitionAttributeValidValuesSetModel`	No	nullable
`selectOrGenerated`	`string`	No	nullable
`selectionType`	`string`	No	nullable
`showOnQuote`	`string`	No	nullable
`hideOnQuoteIfDefault`	`string`	No	nullable
`isRequired`	`string`	No	nullable
`min`	`string`	No	nullable
`max`	`string`	No	nullable
`isActive`	`string`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`queryGetValid`	`QueryValidValuesModel`	No

Used by: PATCH /v1/attributes/{AttributeID} PATCH /v1/attributes/{AttributeID}/query PATCH /v1/attributes/batch PUT /v1/attributes PUT /v1/attributes/batch

DefinitionAttributeValidValueModelobject

Property	Type	Required	Details
`valueID`	`string`	No	nullable
`value`	`string`	No	nullable
`description`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`inventoryStatus`	`ItemLedgerStatusModel`	No
`price`	`number`	No	format: double
`links`	`array of string`	No	nullable

DefinitionAttributeValidValuesSetModelobject

Property	Type	Required	Details
`setID`	`string`	No	nullable
`description`	`string`	No	nullable
`attrsAndValues`	`array of DefinitionAttributeAttrAndValue`	No	nullable
`values`	`array of DefinitionAttributeValidValueModel`	No	nullable
`defaultValueID`	`string`	No	nullable
`catalogAttribute`	`string`	No	nullable
`catalogFilters`	`array of DefinitionAttributeAttrAndValue`	No	nullable
`sortOrder`	`integer`	No	format: int32
`notes`	`array of NoteModel`	No	nullable

DefinitionPageModelobject

Property	Type	Required	Details
`pageID`	`string`	No	nullable
`pageName`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`productID`	`string`	No	nullable
`hideWhen`	`string`	No	nullable
`showWhen`	`string`	No	nullable
`hint`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`attributes`	`array of DefinitionAttributeModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable

Used by: PATCH /v1/pages/{PageID} PUT /v1/pages PUT /v1/pages/batch

DefinitionResourceGroupModelobject

Property	Type	Required	Details
`resourceGroupID`	`string`	No	nullable
`name`	`string`	No	nullable
`purpose`	`string`	No	nullable
`locationID`	`string`	No	nullable
`isActive`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/resourcegroups/{ResourceGroupID} PATCH /v1/resourcegroups/{ResourceGroupID}/notes PUT /v1/resourcegroups

DefinitionResourceModelobject

Property	Type	Required	Details
`resourceID`	`string`	No	nullable
`name`	`string`	No	nullable
`alias`	`string`	No	nullable
`category`	`string`	No	nullable
`locationID`	`string`	No	nullable
`qualityAssetID`	`string`	No	nullable
`userID`	`string`	No	nullable
`acknowledgmentRequired`	`string`	No	nullable
`nonWorkingDays`	`array of CalendarExceptionModel`	No	nullable
`resourceGroupIDs`	`array of string`	No	nullable
`isActive`	`string`	No	nullable
`capacity`	`ResourceCapacityModel`	No
`workDays`	`array of WorkDayModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/resources/{ResourceID} PATCH /v1/resources/{ResourceID}/nonworkingdays PATCH /v1/resources/{ResourceID}/notes PUT /v1/resources

DefinitionRuleGroupModelobject

Property	Type	Required	Details
`ruleGroupID`	`string`	No	nullable
`groupName`	`string`	No	nullable
`groupPriority`	`integer`	No	format: int32
`productID`	`string`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

DefinitionRuleModelobject

Property	Type	Required	Details
`ruleID`	`string`	No	nullable
`ruleName`	`string`	No	nullable
`ruleGroupID`	`string`	No	nullable
`priority`	`integer`	No	format: int32
`rule`	`string`	No	nullable
`productID`	`string`	No	nullable
`purpose`	`string`	No	nullable
`requiresUpdate`	`boolean`	No
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable

Used by: PATCH /v1/rules/{RuleID} PUT /v1/rules PUT /v1/rules/batch

DefinitionTaskActionModelobject

Property	Type	Required	Details	Description
`actionID`	`string`	No	nullable

DefinitionTaskInvitationModelobject

Property	Type	Required	Details
`invitationID`	`string`	No	nullable
`supplierID`	`string`	No	nullable
`url`	`string`	No	nullable
`expiresUTC`	`string`	No	format: date-time

DefinitionTaskModelobject

Property	Type	Required	Details
`taskID`	`string`	No	nullable
`taskNumber`	`integer`	No	format: int32
`locationID`	`string`	No	nullable
`name`	`string`	No	nullable
`workCenter`	`string`	No	nullable
`description`	`string`	No	nullable
`phase`	`string`	No	nullable
`pricingComponent`	`string`	No	nullable
`taskType`	`string`	No	nullable
`invitations`	`array of DefinitionTaskInvitationModel`	No	nullable
`actions`	`array of DefinitionTaskActionModel`	No	nullable
`resourceGroupIDs`	`array of string`	No	nullable
`operatingParameters`	`array of string`	No	nullable
`modelXMLtime`	`string`	No	nullable
`modelXMLcost`	`string`	No	nullable
`markup`	`number`	No	format: double
`timeSetup_min`	`number`	No	format: double
`timeTeardown_min`	`number`	No	format: double
`timeTransfer_min`	`number`	No	format: double
`minWait_min`	`number`	No	format: double
`maxWait_min`	`number`	No	format: double
`waitOnPredecessor`	`string`	No	nullable
`nesting`	`DefinitionTaskNestingModel`	No
`workDays`	`array of WorkDayModel`	No	nullable
`nonWorkingDays`	`array of CalendarExceptionModel`	No	nullable
`isActive`	`string`	No	nullable
`timeModels`	`array of RegressionModel`	No	nullable
`costModels`	`array of RegressionModel`	No	nullable
`capacity`	`TaskCapacityModel`	No
`taskHourlyRate`	`number`	No	format: double
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/tasks/{TaskID} PATCH /v1/tasks/{TaskID}/invitations PATCH /v1/tasks/{TaskID}/nesting PATCH /v1/tasks/{TaskID}/nonworkingdays PUT /v1/tasks

DefinitionTaskNestingModelobject

Property	Type	Required	Details
`groupByAttribute`	`string`	No	nullable
`nestingType`	`string`	No	nullable
`limitX_mm`	`number`	No	format: double
`limitY_mm`	`number`	No	format: double
`limitZ_mm`	`number`	No	format: double

DeliveryModelobject

Property	Type	Required	Details
`deliveryID`	`string`	No	nullable
`mode`	`string`	No	nullable
`carrier`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`weight_kg`	`number`	No	format: double
`length_mm`	`number`	No	format: double
`width_mm`	`number`	No	format: double
`height_mm`	`number`	No	format: double
`cost`	`number`	No	format: double

DiagnosticTreeModelobject

Property	Type	Required	Details
`diagnosticTreeID`	`string`	No	nullable
`name`	`string`	No	nullable
`source`	`string`	No	nullable
`link`	`string`	No	nullable
`isActive`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/service/diagnostictrees/{DiagnosticTreeID} PUT /v1/service/diagnostictrees

DiscussionParticipantModelobject

Property	Type	Required	Details	Description
`userID`	`string`	No	nullable
`role`	`string`	No	nullable

Used by: POST /v1/discussions/threads/{threadId}/participants

DiscussionThreadMessageModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`messageID`	`string`	No	nullable
`threadID`	`string`	No	nullable
`senderID`	`string`	No	nullable
`content`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`type`	`MessageType`	No
`metadata`	`object`	No	nullable

Used by: POST /v1/discussions/threads/{threadId}/messages PUT /v1/discussions/messages/{messageId}

DiscussionThreadModelobject

Property	Type	Required	Details
`threadID`	`string`	No	nullable
`primaryKeyID`	`string`	No	nullable
`entityType`	`string`	No	nullable
`referenceIdentifier`	`string`	No	nullable
`topic`	`string`	No	nullable
`messages`	`array of DiscussionThreadMessageModel`	No	nullable
`participants`	`array of DiscussionParticipantModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: POST /v1/discussions/{primaryKeyId}/threads POST /v1/discussions/threads PUT /v1/discussions/threads/{threadId}

DocumentFilesAuditFindingModelobject

Property	Type	Required	Details
`documentID`	`string`	No	nullable
`name`	`string`	No	nullable
`documentType`	`string`	No	nullable
`fileName`	`string`	No	nullable
`expectedFileName`	`string`	No	nullable
`fileFound`	`boolean`	No
`localFileFound`	`boolean`	No
`s3FileFound`	`boolean`	No
`productIDs`	`array of string`	No	nullable

DocumentFilesAuditModelobject

Property	Type	Required	Details
`source`	`string`	No	nullable
`root`	`string`	No	nullable
`documentCount`	`integer`	No	format: int32
`connectedDocumentCount`	`integer`	No	format: int32
`localFoundFileCount`	`integer`	No	format: int32
`s3FoundFileCount`	`integer`	No	format: int32
`foundFileCount`	`integer`	No	format: int32
`missingFileCount`	`integer`	No	format: int32
`orphanedFileCount`	`integer`	No	format: int32
`documents`	`array of DocumentFilesAuditFindingModel`	No	nullable
`orphanedFiles`	`array of string`	No	nullable

Used by: GET /v1/documents/audit/files

DocumentLinkModelobject

Property	Type	Required	Details
`documentLinkID`	`string`	No	nullable
`number`	`string`	No	nullable
`revision`	`string`	No	nullable
`description`	`string`	No	nullable
`url`	`string`	No	nullable
`tags`	`array of TagModel`	No	nullable
`scopes`	`array of string`	No	nullable
`attributes`	`object`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

DocumentModelobject

Property	Type	Required	Details
`documentID`	`string`	No	nullable
`name`	`string`	No	nullable
`revision`	`string`	No	nullable
`description`	`string`	No	nullable
`documentType`	`string`	No	nullable
`fileName`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`visibility`	`string`	No	nullable
`tags`	`array of TagModel`	No	nullable
`attributes`	`object`	No	nullable
`productIDs`	`array of string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/documents/{DocumentID}

DocumentReferenceModelobject

Property	Type	Required	Details
`referenceID`	`string`	No	nullable
`documentID`	`string`	No	nullable
`scopes`	`array of string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

DocumentUploadModelobject

Property	Type	Required	Details
`document`	`DocumentModel`	No
`fileName`	`string`	No	nullable
`fileBytes`	`string`	No	nullable

Used by: PATCH /v1/documents/{DocumentID}/replace POST /v1/documents POST /v1/salesorders/{SalesOrderID}/documents POST /v1/salesquotes/{SalesQuoteID}/documents

EmailAttachmentModelobject

Property	Type	Required	Details	Description
`path`	`string`	No	nullable

EmailContactModelobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`emailAddress`	`string`	No	nullable

EmailMessageModelobject

Property	Type	Required	Details
`emailID`	`string`	No	nullable
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`status`	`string`	No	nullable
`to`	`array of EmailContactModel`	No	nullable
`cc`	`array of EmailContactModel`	No	nullable
`bcc`	`array of EmailContactModel`	No	nullable
`attachments`	`array of EmailAttachmentModel`	No	nullable
`subject`	`string`	No	nullable
`message`	`string`	No	nullable
`isHtml`	`boolean`	No
`createdUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`history`	`array of HistoryModel`	No	nullable

Used by: POST /v1/salesorders/{SalesOrderID}/email POST /v1/salesquotes/{SalesQuoteID}/email/pdf PUT /v1/email PUT /v1/salesfunnel/{OpportunityID}/sendemail

EmailServerModelobject

Property	Type	Required	Details
`displayName`	`string`	No	nullable
`login`	`string`	No	nullable
`password`	`string`	No	nullable
`hostname`	`string`	No	nullable
`port`	`string`	No	nullable
`level`	`string`	No	nullable
`provider`	`string`	No	nullable
`apiKey`	`string`	No	nullable

Used by: PATCH /v1/instances/smtpserver

EmailTemplateModelobject

Property	Type	Required	Details
`templateID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`name`	`string`	No	nullable
`subject`	`string`	No	nullable
`bodyHTML`	`string`	No	nullable
`bodyText`	`string`	No	nullable
`body`	`string`	No	nullable
`isActive`	`string`	No	nullable
`appliesTo`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/email/templates/{TemplateID} POST /v1/email/templates

EmployeeModelobject

Property	Type	Required	Details
`userID`	`string`	No	nullable
`first`	`string`	No	nullable
`last`	`string`	No	nullable
`title`	`string`	No	nullable
`emailAddress`	`string`	No	nullable
`phoneNumbers`	`array of PhoneNumberModel`	No	nullable
`phoneOffice`	`string`	No	nullable
`phoneMobile`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`managerUserID`	`string`	No	nullable
`resetRequired`	`string`	No	nullable
`isActive`	`string`	No	nullable
`offsetUTC`	`number`	No	format: double
`globalRoles`	`array of string`	No	nullable
`instanceAccess`	`array of UserTenantAccessModel`	No	nullable
`profiles`	`array of UserProfileBaseModel`	No	nullable

Used by: PATCH /v1/employees/{EmployeeID} PUT /v1/employees

EndCustomerModelobject

Property	Type	Required	Details
`endCustomerID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`name`	`string`	No	nullable
`number`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable

EscalationTemplateModelobject

Property	Type	Required	Details
`templateID`	`string`	No	nullable
`name`	`string`	No	nullable
`template`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/escalation/templates/{TemplateID} POST /v1/escalation/templates

EventSlicerModelobject

Property	Type	Required	Details	Description
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32

Used by: POST /v1/events/count POST /v1/events/pages/{page}

FeatureModelobject

Property	Type	Required	Details
`featureID`	`string`	No	nullable
`appID`	`string`	No	nullable
`enabled`	`boolean`	No
`canEdit`	`boolean`	No
`notes`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdateddUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable

FeedbackRequestParametersobject

Property	Type	Required	Details
`email`	`string`	No	nullable
`message`	`string`	No	nullable
`setID`	`string`	No	nullable

Used by: POST /v1/products/{ProductID}/attributes/{AttributeID}/feedback/request

FileUploadModelobject

Property	Type	Required	Details	Description
`fileName`	`string`	No	nullable
`fileBytes`	`string`	No	nullable

Used by: POST /v1/serialization/import

FilterConditionModelobject

Property	Type	Required	Details
`field`	`string`	No	nullable
`operator`	`string`	No	nullable
`value`		No	nullable

FilterModeinteger

ForgeAiAttributeModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`pageTemporaryID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`dataType`	`string`	No	nullable
`selectionType`	`string`	No	nullable
`units`	`string`	No	nullable
`defaultValue`	`string`	No	nullable
`isRequired`	`boolean`	No

ForgeAiAttributeValueModelobject

Property	Type	Required	Details	Description
`attributeTemporaryID`	`string`	No	nullable
`value`	`string`	No	nullable

ForgeAiBusinessContextModelobject

Property	Type	Required	Details
`businessProblem`	`string`	No	nullable
`targetMarket`	`string`	No	nullable
`targetCustomer`	`string`	No	nullable
`productFamily`	`string`	No	nullable
`productName`	`string`	No	nullable
`productSku`	`string`	No	nullable
`commercialIntent`	`string`	No	nullable
`defaultUnits`	`string`	No	nullable
`terminology`	`array of string`	No	nullable
`constraints`	`array of string`	No	nullable
`notes`	`string`	No	nullable

Used by: POST /v1/forge/ai/jobs

ForgeAiEvidenceModelobject

Property	Type	Required	Details
`evidenceID`	`string`	No	nullable
`entityTemporaryID`	`string`	No	nullable
`sourceID`	`string`	No	nullable
`location`	`string`	No	nullable
`excerpt`	`string`	No	nullable
`confidence`	`number`	No	format: double
`rationale`	`string`	No	nullable

ForgeAiItemMappingModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`conditions`	`array of ForgeAiAttributeValueModel`	No	nullable
`items`	`array of ForgeAiItemQuantityModel`	No	nullable

ForgeAiItemQuantityModelobject

Property	Type	Required	Details	Description
`itemNumber`	`string`	No	nullable
`quantity`	`number`	No	format: double

ForgeAiPageModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32

ForgeAiProductModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`name`	`string`	No	nullable
`sku`	`string`	No	nullable
`description`	`string`	No	nullable
`category`	`string`	No	nullable

ForgeAiRuleGroupModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`name`	`string`	No	nullable
`priority`	`integer`	No	format: int32

ForgeAiRuleModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`ruleGroupTemporaryID`	`string`	No	nullable
`name`	`string`	No	nullable
`expression`	`string`	No	nullable
`priority`	`integer`	No	format: int32

ForgeAiSetupJobModelobject

Property	Type	Required	Details
`jobID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`productID`	`string`	No	nullable
`state`	`string`	No	nullable
`rowVersion`	`integer`	No	format: int64
`businessContext`	`ForgeAiBusinessContextModel`	No
`package`	`ForgeAiSetupPackageModel`	No
`validation`	`ForgeAiValidationReportModel`	No
`processingStatus`	`string`	No	nullable
`processingMessage`	`string`	No	nullable
`modelName`	`string`	No	nullable
`promptVersion`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/forge/ai/jobs/{jobID} PATCH /v1/forge/ai/jobs/{jobID}/context PATCH /v1/forge/ai/jobs/{jobID}/package POST /v1/forge/ai/jobs

ForgeAiSetupPackageModelobject

Property	Type	Required	Details
`schemaVersion`	`integer`	No	format: int32
`businessContext`	`ForgeAiBusinessContextModel`	No
`product`	`ForgeAiProductModel`	No
`pages`	`array of ForgeAiPageModel`	No	nullable
`attributes`	`array of ForgeAiAttributeModel`	No	nullable
`validValueSets`	`array of ForgeAiValidValueSetModel`	No	nullable
`ruleGroups`	`array of ForgeAiRuleGroupModel`	No	nullable
`rules`	`array of ForgeAiRuleModel`	No	nullable
`itemMappings`	`array of ForgeAiItemMappingModel`	No	nullable
`evidence`	`array of ForgeAiEvidenceModel`	No	nullable
`warnings`	`array of string`	No	nullable

ForgeAiTransitionRequestModelobject

Property	Type	Required	Details	Description
`command`	`string`	No	nullable
`rowVersion`	`integer`	No	format: int64

Used by: POST /v1/forge/ai/jobs/{jobID}/transitions

ForgeAiTransitionResultModelobject

Property	Type	Required	Details
`succeeded`	`boolean`	No
`previousState`	`string`	No	nullable
`state`	`string`	No	nullable
`error`	`string`	No	nullable
`allowedCommands`	`array of string`	No	nullable

Used by: POST /v1/forge/ai/jobs/{jobID}/transitions

ForgeAiUpdateBusinessContextRequestModelobject

Property	Type	Required	Details	Description
`rowVersion`	`integer`	No	format: int64
`businessContext`	`ForgeAiBusinessContextModel`	No

Used by: PATCH /v1/forge/ai/jobs/{jobID}/context

ForgeAiUpdatePackageRequestModelobject

Property	Type	Required	Details	Description
`rowVersion`	`integer`	No	format: int64
`package`	`ForgeAiSetupPackageModel`	No

Used by: PATCH /v1/forge/ai/jobs/{jobID}/package

ForgeAiValidationFindingModelobject

Property	Type	Required	Details
`findingID`	`string`	No	nullable
`severity`	`string`	No	nullable
`code`	`string`	No	nullable
`message`	`string`	No	nullable
`entityTemporaryID`	`string`	No	nullable

ForgeAiValidationReportModelobject

Property	Type	Required	Details	Description
`findings`	`array of ForgeAiValidationFindingModel`	No	nullable
`hasBlockingFindings`	`boolean`	No

ForgeAiValidValueSetModelobject

Property	Type	Required	Details
`temporaryID`	`string`	No	nullable
`attributeTemporaryID`	`string`	No	nullable
`description`	`string`	No	nullable
`defaultValue`	`string`	No	nullable
`values`	`array of string`	No	nullable

ForgeTerminologyModelobject

Property	Type	Required	Details
`quotesNavigation`	`string`	No	nullable
`ordersNavigation`	`string`	No	nullable
`smartQuote`	`string`	No	nullable
`sales`	`string`	No	nullable
`salesQuote`	`string`	No	nullable
`salesQuotes`	`string`	No	nullable
`orders`	`string`	No	nullable
`salesOrder`	`string`	No	nullable
`salesOrders`	`string`	No	nullable
`customer`	`string`	No	nullable
`customers`	`string`	No	nullable
`production`	`string`	No	nullable
`productionOrder`	`string`	No	nullable
`productionOrders`	`string`	No	nullable
`daysElapsed`	`string`	No	nullable
`notes`	`string`	No	nullable

GeneralSettingsModelobject

Property	Type	Required	Details
`showSmartQuoteLinkNav`	`string`	No	nullable
`showCostAndPricing`	`string`	No	nullable
`showBillOfMaterials`	`string`	No	nullable
`usePricingComponents`	`string`	No	nullable
`showItemDetailInLineItemsTable`	`string`	No	nullable
`salesQuoteAllowSendByEmail`	`string`	No	nullable
`customersAllowAdd`	`string`	No	nullable
`itemsAllowAdd`	`string`	No	nullable
`salesQuoteMetaDataLabels`	`array of string`	No	nullable
`salesOrderNumberPrefix`	`string`	No	nullable
`salesQuoteNumberFormat`	`string`	No	nullable
`salesQuoteDefaultPhase`	`string`	No	nullable
`salesFunnelNumberPrefix`	`string`	No	nullable
`timingApproach`	`string`	No	nullable

GeoCoordinatesModelobject

Property	Type	Required	Details	Description
`latitude`	`number`	No	format: double
`longitude`	`number`	No	format: double

GlobalSearchLiteResultModelobject

Global Search response using lightweight customer and item result rows.

Property	Type	Required	Details
`serviceTickets`	`array of ServiceTicketModel`	No	nullable
`serials`	`array of SerializationSerialNumberModel`	No	nullable
`salesQuotes`	`array of SalesQuoteModel`	No	nullable
`salesOrders`	`array of SalesOrderModel`	No	nullable
`customers`	`array of CustomerSearchModel`	No	nullable
`productionOrders`	`array of ProductionOrderModel`	No	nullable
`items`	`array of ItemSearchModel`	No	nullable
`itemCompatibilities`	`array of ItemCompatibilityModel`	No	nullable
`salesTargets`	`array of SalesOpportunityModel`	No	nullable
`queues`	`array of ProductionQueueModel`	No	nullable
`qualityNcr`	`array of QualityNcrModel`	No	nullable
`qualityAssets`	`array of QualityAssetModel`	No	nullable
`suppliers`	`array of SupplierModel`	No	nullable
`productionOrderCustomers`	`object`	No	nullable

Used by: POST /v1/search/lite-customer-items

GlobalSearchRequestModelobject

Property	Type	Required	Details	Description
`query`	`string`	No	nullable
`limit`	`integer`	No	format: int32

Used by: POST /v1/search POST /v1/search/lite-customer-items

GlobalSearchResultModelobject

Property	Type	Required	Details
`serviceTickets`	`array of ServiceTicketModel`	No	nullable
`serials`	`array of SerializationSerialNumberModel`	No	nullable
`salesQuotes`	`array of SalesQuoteModel`	No	nullable
`salesOrders`	`array of SalesOrderModel`	No	nullable
`customers`	`array of CustomerModel`	No	nullable
`productionOrders`	`array of ProductionOrderModel`	No	nullable
`items`	`array of ItemModel`	No	nullable
`itemCompatibilities`	`array of ItemCompatibilityModel`	No	nullable
`salesTargets`	`array of SalesOpportunityModel`	No	nullable
`queues`	`array of ProductionQueueModel`	No	nullable
`qualityNcr`	`array of QualityNcrModel`	No	nullable
`qualityAssets`	`array of QualityAssetModel`	No	nullable
`suppliers`	`array of SupplierModel`	No	nullable
`productionOrderCustomers`	`object`	No	nullable

Used by: POST /v1/search

HeatMapDataModelobject

Property	Type	Required	Details
`x`	`integer`	No	format: int32
`y`	`integer`	No	format: int32
`value`	`integer`	No	format: int32

HistoryModelobject

Property	Type	Required	Details
`historyID`	`string`	No	nullable
`activity`	`string`	No	nullable
`byUserID`	`string`	No	nullable
`dateTimeUTC`	`string`	No	format: date-time

HomeModelobject

Property	Type	Required	Details
`recentViews`	`object`	No	nullable
`phasesQuotes`	`array of PhaseModel`	No	nullable
`phasesProduction`	`array of PhaseModel`	No	nullable
`notes`	`array of NoteWithParentIdModel`	No	nullable
`toDoFunnel`	`array of ToDoModel`	No	nullable
`toDoSalesQuotes`	`array of ToDoModel`	No	nullable
`toDoSalesOrders`	`array of ToDoModel`	No	nullable
`tour`	`UserTourModel`	No
`isResourceAssigned`	`boolean`	No
`nonWorkingDays`	`array of CalendarExceptionModel`	No	nullable
`escalations`	`DashboardEscalationsResponse`	No
`countsSalesQuotes`	`object`	No	nullable
`countsSalesOrders`	`object`	No	nullable
`countsProductionOrders`	`object`	No	nullable
`countsTroubleReports`	`object`	No	nullable
`promotions`	`array of PromotionModel`	No	nullable
`teams`	`array of TeamModel`	No	nullable
`recentSalesQuotes`	`array of SalesQuoteModel`	No	nullable
`recentSalesOrders`	`array of SalesOrderModel`	No	nullable

Used by: GET /v1/home/dashboard

ImageModelobject

Property	Type	Required	Details
`imageID`	`string`	No	nullable
`description`	`string`	No	nullable
`fileName`	`string`	No	nullable
`comments`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/prodorders/{ProductionOrderID}/images/{ImageID} PATCH /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}

ImportMessageModelobject

Property	Type	Required	Details
`logID`	`string`	No	nullable
`lineNumber`	`integer`	No	format: int32
`message`	`string`	No	nullable
`logType`	`string`	No	nullable
`data`	`string`	No	nullable

ImportResultModelobject

Property	Type	Required	Details
`importID`	`string`	No	nullable
`messages`	`array of ImportMessageModel`	No	nullable
`errors`	`array of ImportMessageModel`	No	nullable
`status`	`string`	No	nullable
`linesProcessed`	`integer`	No	format: int32
`fileName`	`string`	No	nullable
`timeRequired`	`number`	No	format: double
`created`	`integer`	No	format: int32
`updated`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/salesorders/import/results POST /v1/salesorders/import

IncotermDefinitionModelobject

Property	Type	Required	Details
`termID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`effectiveYear`	`integer`	No	format: int32
`mode`	`IncotermMode`	No

Used by: PATCH /v1/global/incoterms/{TermID} POST /v1/global/incoterms

IncotermModeinteger

InstanceModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`companyName`	`string`	No	nullable
`name`	`string`	No	nullable
`website`	`string`	No	nullable
`allowedCountries`	`string`	No	nullable
`currencyID`	`string`	No	nullable
`currencyIDs`	`array of string`	No	nullable
`unitsWeight`	`string`	No	nullable
`unitsLength`	`string`	No	nullable
`offsetUTC`	`number`	No	format: double
`defaultMarkup`	`number`	No	format: double
`schedulingAlgorithm`	`SchedulingAlgorithmModel`	No
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable
`culture`	`string`	No	nullable
`defaultPaymentTerms`	`string`	No	nullable
`tenantType`	`string`	No	nullable
`instanceType`	`string`	No	nullable
`storeRequireLogin`	`string`	No	nullable
`subscriptionExpiresUTC`	`string`	No	format: date-time
`featureSalesFunnel`	`string`	No	nullable
`features`	`object`	No	nullable
`featureConfigurator`	`string`	No	nullable
`featureBuilder`	`string`	No	nullable
`featureSalesQuotes`	`string`	No	nullable
`featureSalesOrders`	`string`	No	nullable
`featureBids`	`string`	No	nullable
`featureProduction`	`string`	No	nullable
`featureService`	`string`	No	nullable
`featureStore`	`string`	No	nullable
`featureMaintenance`	`string`	No	nullable
`featureShipping`	`string`	No	nullable
`featurePromotions`	`string`	No	nullable
`featureDelivery`	`string`	No	nullable
`featureSuppliers`	`string`	No	nullable
`featureInvoicing`	`string`	No	nullable
`featurePurchasing`	`string`	No	nullable
`featureWarehouse`	`string`	No	nullable
`featureInventory`	`string`	No	nullable
`featureQuality`	`string`	No	nullable
`featureHelp`	`string`	No	nullable
`featureCompany`	`string`	No	nullable
`emailCc`	`array of EmailContactModel`	No	nullable
`incoterm`	`OrganizationIncotermModel`	No
`integrationJustPlanIt`	`IntegrationJustPlanItModel`	No
`integrationQuickBooks`	`IntegrationQuickBooksModel`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`updatedTUTC`	`string`	No	format: date-time

InstructionDetailModelobject

Property	Type	Required	Details	Description
`instruction`	`string`	No	nullable
`time_min`	`integer`	No	format: int32

InstructionModelobject

Property	Type	Required	Details
`instructionID`	`string`	No	nullable
`productID`	`string`	No	nullable
`taskID`	`string`	No	nullable
`description`	`string`	No	nullable
`appliesWhen`	`string`	No	nullable
`instructions`	`array of InstructionDetailModel`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/instructions/{taskid}

Int32ApiResponseModelobject

Property	Type	Required	Details
`success`	`boolean`	No
`message`	`string`	No	nullable
`errors`	`array of string`	No	nullable
`errorCode`	`string`	No	nullable
`data`	`integer`	No	format: int32

Used by: PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute

IntegrationActionModelobject

Property	Type	Required	Details
`actionID`	`string`	No	nullable
`provider`	`string`	No	nullable
`label`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`showOn`	`string`	No	nullable
`requiresConfirmation`	`boolean`	No
`isActive`	`boolean`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

IntegrationExecuteRequestModelobject

Property	Type	Required	Details	Description
`actionID`	`string`	No	nullable
`entityID`	`string`	No	nullable

Used by: PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute

IntegrationHelcimConfigModelobject

Property	Type	Required	Details
`accountID`	`string`	No	nullable
`apiToken`	`string`	No	nullable
`environment`	`string`	No	nullable
`webhookSecret`	`string`	No	nullable
`isActive`	`string`	No	nullable

IntegrationJustPlanItModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`apikey`	`string`	No	nullable
`statusesToSend`	`array of integer`	No	nullable
`weeksDataToSend`	`integer`	No	format: int32
`isActive`	`string`	No	nullable

IntegrationModelobject

Property	Type	Required	Details
`integrationID`	`string`	No	nullable
`name`	`string`	No	nullable
`provider`	`string`	No	nullable
`providerJSON`	`string`	No	nullable
`actions`	`array of IntegrationActionModel`	No	nullable
`helcimConfig`	`IntegrationHelcimConfigModel`	No
`slackConfig`	`IntegrationSlackConfigModel`	No
`isActive`	`boolean`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/instances/{InstanceID}/integrations GET /v1/instances/{InstanceID}/integrations/{IntegrationID}

IntegrationQuickBooksModelobject

Property	Type	Required	Details
`clientID`	`string`	No	nullable
`clientSecret`	`string`	No	nullable
`isActive`	`string`	No	nullable

IntegrationSlackConfigModelobject

Property	Type	Required	Details	Description
`webhooks`	`array of SlackWebhookDefinition`	No	nullable

InventoryAvailabilityAssessmentModelobject

Property	Type	Required	Details
`source`	`string`	No	nullable
`snapshotAtUTC`	`string`	No	format: date-time
`isHealthy`	`boolean`	No
`items`	`array of InventoryAvailabilityItemModel`	No	nullable

Used by: POST /v1/inventory/availability/assessments

InventoryAvailabilityAssessmentRequestModelobject

Property	Type	Required	Details
`requestID`	`string`	No	nullable
`requestedAtUTC`	`string`	No	format: date-time
`requirements`	`array of InventoryAvailabilityRequirementModel`	No	nullable

Used by: POST /v1/inventory/availability/assessments

InventoryAvailabilityItemModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`onHandQuantity`	`number`	No	format: double
`allocatedQuantity`	`number`	No	format: double nullable
`availableQuantity`	`number`	No	format: double
`inboundQuantity`	`number`	No	format: double nullable
`nextReceiptUTC`	`string`	No	format: date-time nullable
`uom`	`string`	No	nullable

InventoryAvailabilityRequirementModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`quantity`	`number`	No	format: double
`uom`	`string`	No	nullable

InventoryLocationModelobject

Property	Type	Required	Details
`locationID`	`string`	No	nullable
`name`	`string`	No	nullable
`groupName`	`string`	No	nullable
`isActive`	`string`	No	nullable
`coordinates`	`GeoCoordinatesModel`	No
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/inventory/locations/{LocationID} PATCH /v1/inventory/locations/{LocationID}/notes PUT /v1/inventory/locations

InventoryLocationsSlicerModelobject

Property	Type	Required	Details
`isActive`	`string`	No	nullable
`group`	`string`	No	nullable
`sortBy`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

Used by: POST /v1/inventory/locations

InventoryReceiveModelobject

Property	Type	Required	Details
`inventoryReceiveID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`quantity`	`number`	No	format: double
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/receive

InventoryShortageItemModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`description`	`string`	No	nullable
`uom`	`string`	No	nullable
`requiredQuantity`	`number`	No	format: double
`onHandQuantity`	`number`	No	format: double
`availableQuantity`	`number`	No	format: double
`shortfallQuantity`	`number`	No	format: double

InventoryShortageNotificationModelobject

Read-only buyer-review handoff. It never creates a purchase order.

Property	Type	Required	Details
`notificationID`	`string`	No	nullable
`productID`	`string`	No	nullable
`productName`	`string`	No	nullable
`availabilitySource`	`string`	No	nullable
`snapshotAtUTC`	`string`	No	format: date-time nullable
`items`	`array of InventoryShortageItemModel`	No	nullable

Used by: POST /v1/inventory/availability/shortages

InventoryTransferModelobject

Property	Type	Required	Details
`inventoryMoveID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`quantity`	`number`	No	format: double
`fromLocationID`	`string`	No	nullable
`toLocationID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/move

InvoiceLineModelobject

Property	Type	Required	Details
`invoiceLineID`	`string`	No	nullable
`lineItemID`	`string`	No	nullable
`description`	`string`	No	nullable
`unitPrice`	`number`	No	format: double
`quantity`	`number`	No	format: double

InvoiceModelobject

Property	Type	Required	Details
`invoiceID`	`string`	No	nullable
`number`	`string`	No	nullable
`status`	`string`	No	nullable
`customerID`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`currencyID`	`string`	No	nullable
`personBillTo`	`PersonModel`	No
`personShipTo`	`PersonModel`	No
`billTo`	`CustomerBillToModel`	No
`shipTo`	`CustomerShipToModel`	No
`lines`	`array of InvoiceLineModel`	No	nullable
`dueUTC`	`string`	No	format: date-time
`paidUTC`	`string`	No	format: date-time
`notes`	`string`	No	nullable
`terms`	`string`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/instance/invoices/{InvoiceID} PATCH /v1/invoices/{InvoiceID} PUT /v1/instance/invoices PUT /v1/invoices

ItemAndQtyModelobject

Property	Type	Required	Details
`itemAndQtyID`	`string`	No	nullable
`lineNumber`	`integer`	No	format: int32
`details`	`ItemModel`	No
`quantity`	`number`	No	format: double
`discount`	`number`	No	format: double
`baseUnitPrice`	`number`	No	format: double
`status`	`string`	No	nullable
`showSubTotal`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`isCustom`	`boolean`	No
`equivalentItemNumbers`	`array of string`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`documentNames`	`array of string`	No	nullable
`documentIDs`	`array of string`	No	nullable

Used by: PUT /v1/salesquotes/{SalesQuoteID}/items

ItemAttributeModelobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`value`	`string`	No	nullable

ItemCompatibilityModelobject

Property	Type	Required	Details
`compatibilityID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`baseItemID`	`string`	No	nullable
`compatibleItemID`	`string`	No	nullable
`compatibilityType`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: POST /v1/items/compatibility PUT /v1/items/compatibility/{CompatibilityID}

ItemComponentModelobject

Property	Type	Required	Details	Description
`componentItemID`	`string`	No	nullable
`quantity`	`number`	No	format: double

ItemCostHistoryModelobject

Property	Type	Required	Details
`dateTimeUTC`	`string`	No	format: date-time
`cost`	`number`	No	format: double
`createdByUserID`	`string`	No	nullable

ItemCostReviewEntryModelobject

Property	Type	Required	Details
`entryID`	`string`	No	nullable
`itemID`	`integer`	No	format: int32
`productID`	`integer`	No	format: int32
`costPrevious`	`number`	No	format: double
`costCurrent`	`number`	No	format: double
`costNew`	`number`	No	format: double
`variance`	`number`	No	format: double
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

ItemCostReviewModelobject

Property	Type	Required	Details
`reviewID`	`string`	No	nullable
`reviewMonth`	`string`	No	format: date-time
`reviewerUserID`	`string`	No	nullable
`approvedByUserID`	`integer`	No	format: int32
`status`	`ReviewStatus`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`entries`	`array of ItemCostReviewEntryModel`	No	nullable

Used by: PATCH /v1/items/reviews/{ReviewID}/basics PUT /v1/items/reviews

ItemLedgerModelobject

Property	Type	Required	Details
`itemLedgerID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`quantityChange`	`number`	No	format: double
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`referenceLineNumber`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory

ItemLedgerStatusModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`uom`	`string`	No	nullable
`quantity`	`number`	No	format: double
`locationID`	`string`	No	nullable

ItemMappingAttrAndValueobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`value`	`string`	No	nullable

ItemMappingItemAndQtyobject

Property	Type	Required	Details
`number`	`string`	No	nullable
`quantity`	`number`	No	format: double
`inventoryStatus`	`ItemLedgerStatusModel`	No

ItemMappingModelobject

Property	Type	Required	Details
`productID`	`string`	No	nullable
`itemMappingID`	`string`	No	nullable
`category`	`string`	No	nullable
`items`	`array of ItemMappingItemAndQty`	No	nullable
`attributesAndValues`	`array of ItemMappingAttrAndValue`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`errors`	`array of string`	No	nullable
`comment`	`string`	No	nullable
`requiresUpdate`	`boolean`	No
`isRequired`	`boolean`	No
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/itemmapping PATCH /v1/itemmapping/{ItemMappingID}/history PUT /v1/itemmapping

ItemModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`description`	`string`	No	nullable
`longDescription`	`string`	No	nullable
`fullDescription`	`string`	No	nullable
`number`	`string`	No	nullable
`uom`	`string`	No	nullable
`category`	`string`	No	nullable
`components`	`array of ItemComponentModel`	No	nullable
`parentItemID`	`string`	No	nullable
`weightPerUnit`	`number`	No	format: double
`unitCost`	`number`	No	format: double
`unitPrice`	`number`	No	format: double
`grossMarginFloor`	`number`	No	format: double
`pricingFloor`	`number`	No	format: double
`minimumAcceptablePrice`	`number`	No	format: double
`pricingComponent`	`string`	No	nullable
`leadTimeDays`	`integer`	No	format: int32
`minimumOrderQuantity`	`number`	No	format: double
`leadTimeWeeks`	`number`	No	format: double
`originCountryID`	`string`	No	nullable
`hts`	`string`	No	nullable
`eccn`	`string`	No	nullable
`intercompanyTerm`	`string`	No	nullable
`serializationRequired`	`string`	No	nullable
`traceablityRequired`	`string`	No	nullable
`isActive`	`string`	No	nullable
`isDeleted`	`boolean`	No
`lifecycleStatus`	`string`	No	nullable
`availabilityStatus`	`string`	No	nullable
`availabilityEffectiveUTC`	`string`	No	format: date-time nullable
`availabilityReason`	`string`	No	nullable
`successorItemID`	`string`	No	nullable
`statusUpdatedUTC`	`string`	No	format: date-time nullable
`isInventory`	`string`	No	nullable
`priceBreaks`	`array of ItemPriceBreakModel`	No	nullable
`router`	`array of ItemTaskModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`attributes`	`array of ItemAttributeModel`	No	nullable
`costHistory`	`array of ItemCostHistoryModel`	No	nullable
`supplierItemNumbers`	`array of ItemSupplierProductModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/items/{ItemID}/attributes PATCH /v1/items/{ItemID}/basics PATCH /v1/items/{ItemID}/links PATCH /v1/items/{ItemID}/pricebreaks PATCH /v1/items/{ItemID}/router PATCH /v1/items/batch PUT /v1/items PUT /v1/items/batch

ItemPriceBreakModelobject

Property	Type	Required	Details
`breakID`	`string`	No	nullable
`quantityMin`	`number`	No	format: double
`quantityMax`	`number`	No	format: double
`price`	`number`	No	format: double

ItemReviewModelobject

Property	Type	Required	Details
`item`	`ItemModel`	No
`cost`	`string`	No	nullable
`price`	`string`	No	nullable

Used by: PUT /v1/items/{ItemID}/review

ItemSearchModelobject

Fields required to render an item Global Search result.

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable

ItemSerializationModelobject

Property	Type	Required	Details
`itemSerializationID`	`string`	No	nullable
`itemAndQtyID`	`string`	No	nullable
`serialNumber`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

ItemsSlicerModelobject

Property	Type	Required	Details
`isActive`	`string`	No	nullable
`deleted`	`string`	No	nullable
`hasAttributes`	`string`	No	nullable
`lifecycleStatus`	`string`	No	nullable
`availabilityStatus`	`string`	No	nullable
`category`	`string`	No	nullable
`countryID`	`string`	No	nullable
`unitCost`	`number`	No	format: double
`unitPrice`	`number`	No	format: double
`sortBy`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

Used by: POST /v1/items/analysis/costandprice POST /v1/items/count POST /v1/items/pages/{page}

ItemSupplierProductModelobject

Property	Type	Required	Details
`supplierID`	`string`	No	nullable
`supplierProductNumber`	`string`	No	nullable
`uom`	`string`	No	nullable
`leadTimeDays`	`integer`	No	format: int32
`isPreferred`	`boolean`	No
`lastCostDate`	`string`	No	format: date-time nullable
`priceBreaks`	`array of SupplierPriceBreakModel`	No	nullable

ItemTaskModelobject

Property	Type	Required	Details
`itemTaskID`	`string`	No	nullable
`number`	`integer`	No	format: int32
`name`	`string`	No	nullable
`workCenter`	`string`	No	nullable
`detail`	`string`	No	nullable
`time_MIN`	`number`	No	format: double
`cost_CUR`	`number`	No	format: double
`price_CUR`	`number`	No	format: double
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

ItemTraceabilityModelobject

Property	Type	Required	Details
`itemTraceabilityID`	`string`	No	nullable
`itemAndQtyID`	`string`	No	nullable
`lotNumber`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

JTokenarray of JToken

Used by: PATCH /v1/customers/{CustomerID}/shipto/{ShipToID}

LineItemAttrModelobject

Property	Type	Required	Details
`lineItemAttrID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`method`	`string`	No	nullable
`attributeDataType`	`string`	No	nullable
`attributeValue`	`string`	No	nullable
`attributeUnits`	`string`	No	nullable

LineItemChargeModelobject

Property	Type	Required	Details
`chargeID`	`string`	No	nullable
`type`	`string`	No	nullable
`description`	`string`	No	nullable
`code`	`string`	No	nullable
`rate`	`number`	No	format: double
`basis`	`string`	No	nullable
`amount`	`number`	No	format: double
`ruleSource`	`string`	No	nullable

LineItemItemAndQtyModelobject

Property	Type	Required	Details
`itemAndQtyID`	`string`	No	nullable
`details`	`LineItemItemModel`	No
`quantity`	`number`	No	format: double
`referenceID`	`string`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`documentNames`	`array of string`	No	nullable
`documentIDs`	`array of string`	No	nullable

LineItemItemModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`description`	`string`	No	nullable
`number`	`string`	No	nullable
`uom`	`string`	No	nullable
`unitCost`	`number`	No	format: double
`unitPrice`	`number`	No	format: double
`category`	`string`	No	nullable
`originCountryID`	`string`	No	nullable
`hts`	`string`	No	nullable
`eccn`	`string`	No	nullable
`pricingComponent`	`string`	No	nullable
`leadTimeDays`	`integer`	No	format: int32
`serializationRequired`	`string`	No	nullable
`traceablityRequired`	`string`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`referencesRules`	`array of ReferenceModel`	No	nullable
`referencesDynBOM`	`array of ReferenceModel`	No	nullable
`referencesAttributes`	`array of ReferenceModel`	No	nullable

LineItemModelobject

Property	Type	Required	Details
`lineItemID`	`string`	No	nullable
`lineNumber`	`integer`	No	format: int32
`productID`	`string`	No	nullable
`fingerPrint`	`string`	No	nullable
`sourceDocumentID`	`string`	No	nullable
`effectiveSourceDocumentID`	`string`	No	nullable
`sourceLineItemID`	`string`	No	nullable
`isBatchLine`	`boolean`	No
`batchID`	`string`	No	nullable
`batchChargeLineID`	`string`	No	nullable
`batchSourceLineItemIDs`	`array of string`	No	nullable
`hasBatchSourceLineItems`	`boolean`	No
`description`	`string`	No	nullable
`longDescription`	`string`	No	nullable
`baseMaterialsPrice`	`number`	No	format: double
`baseTasksPrice`	`number`	No	format: double
`basePrice`	`number`	No	format: double
`quantity`	`number`	No	format: double
`discount`	`number`	No	format: double
`status`	`string`	No	nullable
`schedulingPriority`	`string`	No	nullable
`schedulingNotes`	`string`	No	nullable
`leadTimeDays`	`integer`	No	format: int32
`leadTimeWeeks`	`number`	No	format: double
`attributes`	`array of LineItemAttrModel`	No	nullable
`tasks`	`array of LineItemTaskModel`	No	nullable
`items`	`array of LineItemItemAndQtyModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`charges`	`array of LineItemChargeModel`	No	nullable
`allowDiscount`	`boolean`	No
`lengthUOM`	`string`	No	nullable
`weightUOM`	`string`	No	nullable
`showSubTotal`	`string`	No	nullable
`serializationRequired`	`string`	No	nullable
`weight`	`number`	No	format: double
`length`	`number`	No	format: double
`width`	`number`	No	format: double
`height`	`number`	No	format: double
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`isDeleted`	`boolean`	No
`deletedUTC`	`string`	No	format: date-time
`deletedByUserID`	`string`	No	nullable

Used by: PUT /v1/salesquotes/{SalesQuoteID}/lineitems

LineItemResourceGroupModelobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`usage`	`number`	No	format: double

LineItemTaskModelobject

Property	Type	Required	Details
`lineItemTaskID`	`string`	No	nullable
`workCenter`	`string`	No	nullable
`name`	`string`	No	nullable
`detail`	`string`	No	nullable
`taskNumber`	`integer`	No	format: int32
`pricingComponent`	`string`	No	nullable
`timeSetup_min`	`number`	No	format: double
`timeTeardown_min`	`number`	No	format: double
`timeTransfer_min`	`number`	No	format: double
`isTimeBillable`	`boolean`	No
`time_MIN`	`number`	No	format: double
`cost_CUR`	`number`	No	format: double
`price_CUR`	`number`	No	format: double
`verifications`	`array of LineItemTaskVerificationModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`resourceGroups`	`array of LineItemResourceGroupModel`	No	nullable
`information`	`array of string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`batchRequirements`	`array of BatchRequirementModel`	No	nullable

LineItemTaskVerificationModelobject

Property	Type	Required	Details
`entity`	`string`	No	nullable
`target`	`string`	No	nullable
`targetValue`	`string`	No	nullable
`hintImageUrl`	`string`	No	nullable
`helpUrl`	`string`	No	nullable

LocationModelobject

Property	Type	Required	Details
`locationID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`region`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable
`offsetUTC`	`number`	No	format: double
`workDays`	`array of WorkDayModel`	No	nullable
`nonWorkingDays`	`array of CalendarExceptionModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/locations/{LocationID} PUT /v1/locations

MaintenanceActualModelobject

Property	Type	Required	Details
`actualID`	`string`	No	nullable
`planID`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

MaintenancePlanModelobject

Property	Type	Required	Details
`planID`	`string`	No	nullable
`taskID`	`string`	No	nullable
`description`	`string`	No	nullable
`frequencyType`	`string`	No	nullable
`frequency`	`integer`	No	format: int32
`procedureHours`	`number`	No	format: double
`nextCalendarExceptionID`	`string`	No	nullable
`isActive`	`string`	No	nullable
`actuals`	`array of MaintenanceActualModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/maintenance/plans/{PlanID} PUT /v1/maintenance/plans

MaterialMovementModelobject

Property	Type	Required	Details
`moveID`	`string`	No	nullable
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/warehouse/moves PUT /v1/warehouse/moves

MessageTypeinteger

NoteModelobject

Property	Type	Required	Details
`noteID`	`string`	No	nullable
`note`	`string`	No	nullable
`byUserID`	`string`	No	nullable
`visibility`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/customerorders/{CustomerOrderID}/notes PUT /v1/customers/{CustomerID}/notes PUT /v1/customers/people/{PersonID}/notes PUT /v1/salesfunnel/{OpportunityID}/notes PUT /v1/salesorders/{SalesOrderID}/notes PUT /v1/salesquotes/{SalesQuoteID}/notes

NoteWithParentIdModelobject

Property	Type	Required	Details
`noteID`	`string`	No	nullable
`note`	`string`	No	nullable
`byUserID`	`string`	No	nullable
`visibility`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`parentID`	`string`	No	nullable

NotificationModelobject

Property	Type	Required	Details
`messageID`	`string`	No	nullable
`from`	`string`	No	nullable
`toUserID`	`string`	No	nullable
`messageType`	`string`	No	nullable
`subject`	`string`	No	nullable
`message`	`string`	No	nullable
`url`	`string`	No	nullable
`status`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PUT /v1/notifications/sendtoall PUT /v1/notifications/sendtorole/{Role} PUT /v1/notifications/sendtouser PUT /v1/salesfunnel/sendtouser

NotificationPreferencesModelobject

Property	Type	Required	Details	Description
`events`	`array of string`	No	nullable

OrganizationIncotermModelobject

Property	Type	Required	Details
`termID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`effectiveYear`	`integer`	No	format: int32
`location`	`string`	No	nullable
`notes`	`string`	No	nullable
`isActive`	`boolean`	No

Used by: PATCH /v1/incoterms/{TermID} POST /v1/incoterms

PackingListModelobject

Property	Type	Required	Details
`packingListID`	`string`	No	nullable
`number`	`string`	No	nullable
`status`	`string`	No	nullable
`listType`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`salesLines`	`array of PackingListSalesLineModel`	No	nullable
`salesItems`	`array of PackingListSalesItemModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/packinglists/{PackingListID} PUT /v1/packinglists

PackingListSalesItemModelobject

Property	Type	Required	Details
`packingListItemID`	`string`	No	nullable
`salesItemAndQtyID`	`string`	No	nullable
`quantityToShip`	`integer`	No	format: int32
`quantityShipped`	`integer`	No	format: int32

PackingListSalesLineModelobject

Property	Type	Required	Details
`packingListSalesLineID`	`string`	No	nullable
`salesLineItemID`	`string`	No	nullable
`quantityToShip`	`number`	No	format: double
`quantityShipped`	`number`	No	format: double

PaymentSettingsModelobject

Property	Type	Required	Details	Description
`processor`	`string`	No	nullable

PersonModelobject

Property	Type	Required	Details
`personID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`first`	`string`	No	nullable
`last`	`string`	No	nullable
`emailAddress`	`string`	No	nullable
`title`	`string`	No	nullable
`url`	`string`	No	nullable
`storeIsAuthorized`	`string`	No	nullable
`phoneNumbers`	`array of PhoneNumberModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/customers/people/{PersonID} PUT /v1/customers/people

PhaseHistoryModelobject

Property	Type	Required	Details
`phase`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

PhaseModelobject

Property	Type	Required	Details
`phaseID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`status`	`string`	No	nullable
`phaseType`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`isDefault`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/phases/{PhaseID} POST /v1/phases

PhoneNumberModelobject

Property	Type	Required	Details	Description
`number`	`string`	No	nullable
`numberType`	`string`	No	nullable

PriceListBreakModelobject

Property	Type	Required	Details
`breakID`	`string`	No	nullable
`quantityMin`	`number`	No	format: double
`quantityMax`	`number`	No	format: double
`unitPrice`	`number`	No	format: double nullable
`discountPercent`	`number`	No	format: double nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

PriceListItemModelobject

Property	Type	Required	Details
`listItemID`	`string`	No	nullable
`listID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`basePrice`	`number`	No	format: double
`breaks`	`array of PriceListBreakModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/pricelists/{ListID}/items

PriceListModelobject

Property	Type	Required	Details
`listID`	`string`	No	nullable
`name`	`string`	No	nullable
`customerID`	`string`	No	nullable
`listType`	`string`	No	nullable
`visibilityMode`	`string`	No	nullable
`dateStart`	`string`	No	format: date-time
`dateEnd`	`string`	No	format: date-time
`defaultBreaks`	`array of PriceListBreakModel`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/pricelists/{ListID} PUT /v1/pricelists

PricingChangeRequestModelobject

Property	Type	Required	Details
`pricingChangeRequestID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`sourceType`	`string`	No	nullable
`sourceID`	`string`	No	nullable
`lineItemID`	`string`	No	nullable
`currentUnitPrice`	`number`	No	format: double
`proposedUnitPrice`	`number`	No	format: double
`reason`	`string`	No	nullable
`status`	`string`	No	nullable
`processID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/pricing-change-requests

PricingChangeRequestReceiptobject

Property	Type	Required	Details	Description
`pricingChangeRequestID`	`string`	No	nullable
`message`	`string`	No	nullable

Used by: POST /v1/pricing-change-requests

PricingComponentModelobject

Property	Type	Required	Details
`pricingComponentID`	`string`	No	nullable
`name`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/pricingcomponents/{PricingComponentID} POST /v1/pricingcomponents

ProblemDetailsobject

Property	Type	Required	Details
`type`	`string`	No	nullable
`title`	`string`	No	nullable
`status`	`integer`	No	format: int32 nullable
`detail`	`string`	No	nullable
`instance`	`string`	No	nullable

ProductAiApplyRequestModelobject

Property	Type	Required	Details
`pages`	`array of DefinitionPageModel`	No	nullable
`attributes`	`array of DefinitionAttributeModel`	No	nullable
`ruleGroups`	`array of DefinitionRuleGroupModel`	No	nullable
`rules`	`array of DefinitionRuleModel`	No	nullable

Used by: POST /v1/products/{productID}/ai/apply

ProductChangeRequestModelobject

A durable request to change a Smart Quote product. PROCESS orchestration is intentionally not activated until tenants install the default definition.

Property	Type	Required	Details
`productChangeRequestID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`productID`	`string`	No	nullable
`attributeID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`requestType`	`string`	No	nullable
`message`	`string`	No	nullable
`sourceUrl`	`string`	No	nullable
`configurationSnapshotJson`	`string`	No	nullable
`processTemplateKey`	`string`	No	nullable
`processID`	`string`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/product-change-requests

ProductChangeRequestReceiptobject

Property	Type	Required	Details
`productChangeRequestID`	`string`	No	nullable
`processID`	`string`	No	nullable
`message`	`string`	No	nullable

Used by: POST /v1/product-change-requests

ProductFamilyModelobject

Property	Type	Required	Details
`familyID`	`string`	No	nullable
`name`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/products/families/{FamilyID} POST /v1/products/families

ProductFinderQueryModelobject

Specifies paging and facets for the catalog product finder.

Property	Type	Required	Details
`category`	`string`	No	nullable
`facetSearch`	`string`	No	nullable
`filters`	`array of FilterConditionModel`	No	nullable
`page`	`integer`	No	format: int32
`pageSize`	`integer`	No	format: int32

Used by: POST /v1/items/product-finder

ProductImageModelobject

Property	Type	Required	Details
`imageID`	`string`	No	nullable
`imageBase64`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`createdUTC`	`string`	No	format: date-time

ProductionEventsSlicerModelobject

Property	Type	Required	Details
`userID`	`string`	No	nullable
`productID`	`string`	No	nullable
`taskName`	`string`	No	nullable
`familyID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`fromDate`	`string`	No	format: date-time nullable
`toDate`	`string`	No	format: date-time nullable
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32

Used by: POST /v1/events/prodorders/export POST /v1/prodorders/events POST /v1/prodorders/events/analysis/month POST /v1/prodorders/events/count POST /v1/prodorders/events/page/{page} POST /v1/prodorders/events/pages/{page}

ProductionOrderAuditSlicerModelobject

Property	Type	Required	Details
`productionOrderID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`dateMin`	`string`	No	format: date-time
`dateMax`	`string`	No	format: date-time

Used by: POST /v1/audit/prodorders/phase POST /v1/audit/prodorders/status

ProductionOrderBatchContentModelobject

Property	Type	Required	Details	Description
`productionOrderID`	`string`	No	nullable
`productionOrderTaskID`	`string`	No	nullable

ProductionOrderBatchModelobject

Property	Type	Required	Details
`batchID`	`string`	No	nullable
`name`	`string`	No	nullable
`taskName`	`string`	No	nullable
`groupByAttribute`	`string`	No	nullable
`content`	`array of ProductionOrderBatchContentModel`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/prodorders/batches/{BatchID} PUT /v1/prodorders/batches

ProductionOrderCancelModelobject

Property	Type	Required	Details	Description
`itemAndQtyIDs`	`array of string`	No	nullable
`note`	`NoteModel`	No

Used by: POST /v1/prodorders/{ProductionOrderID}/cancel

ProductionOrderEscalationModelobject

Property	Type	Required	Details
`escalationID`	`string`	No	nullable
`userID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`message`	`string`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`closedUTC`	`string`	No	format: date-time nullable
`documents`	`array of DocumentModel`	No	nullable

Used by: PATCH /v1/prodorders/escalations/{EscalationID}

ProductionOrderEscalationPostModelobject

Property	Type	Required	Details
`escalationID`	`string`	No	nullable
`userID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`message`	`string`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`closedUTC`	`string`	No	format: date-time nullable
`documents`	`array of DocumentUploadModel`	No	nullable

Used by: PUT /v1/prodorders/escalations

ProductionOrderEscalationSlicerModelobject

Property	Type	Required	Details
`createdByUserID`	`string`	No	nullable
`status`	`string`	No	nullable
`customerID`	`string`	No	nullable
`createdUTCYear`	`integer`	No	format: int32
`createdUTCMonth`	`integer`	No	format: int32

Used by: POST /v1/prodorders/escalations POST /v1/prodorders/escalations/pages/{page}

ProductionOrderEventsByMonthModelobject

Property	Type	Required	Details	Description
`months`	`array of ProductionOrderEventsByMonthPointModel`	No	nullable
`totalEvents`	`integer`	No	format: int32

Used by: POST /v1/prodorders/events/analysis/month

ProductionOrderEventsByMonthPointModelobject

Property	Type	Required	Details
`monthUTC`	`string`	No	format: date-time
`eventCount`	`integer`	No	format: int32
`totalMinutes`	`number`	No	format: double
`activeUsers`	`integer`	No	format: int32

ProductionOrderMaterialsRequestModelobject

Property	Type	Required	Details
`requestID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`status`	`string`	No	nullable
`items`	`array of LineItemItemAndQtyModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/schedule/materials/{RequestID}

ProductionOrderModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`number`	`string`	No	nullable
`productionOrderNumber`	`string`	No	nullable
`parentProductionOrderID`	`string`	No	nullable
`status`	`integer`	No	format: int32
`statusText`	`string`	No	nullable
`sequenceNumber`	`integer`	No	format: int32
`salesOrderID`	`string`	No	nullable
`salesOrderLineItemID`	`string`	No	nullable
`serviceTicketID`	`string`	No	nullable
`serviceTicketLineItemID`	`string`	No	nullable
`phase`	`string`	No	nullable
`quantity`	`number`	No	format: double
`serializationRequired`	`string`	No	nullable
`schedulingPriority`	`string`	No	nullable
`schedulingNotes`	`string`	No	nullable
`plannedStartUTC`	`string`	No	format: date-time
`plannedCompletionUTC`	`string`	No	format: date-time
`tasks`	`array of ProductionOrderTaskModel`	No	nullable
`items`	`array of LineItemItemAndQtyModel`	No	nullable
`lenX`	`integer`	No	format: int32
`widthY`	`integer`	No	format: int32
`heightZ`	`integer`	No	format: int32
`touchTime`	`number`	No	format: double
`waitTime`	`number`	No	format: double
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`serialNumbers`	`array of ItemSerializationModel`	No	nullable
`lotNumbers`	`array of ItemTraceabilityModel`	No	nullable
`phaseHistory`	`array of PhaseHistoryModel`	No	nullable
`assignedResourceID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/salesorders/{SalesOrderID}/lineitems/{LineItemID}/prodorders PATCH /v1/prodorders/{ProductionOrderID}/history PATCH /v1/prodorders/{ProductionOrderID}/lotnumbers PATCH /v1/prodorders/{ProductionOrderID}/notes PATCH /v1/prodorders/{ProductionOrderID}/phase PATCH /v1/prodorders/{ProductionOrderID}/serialnumbers PATCH /v1/prodorders/{ProductionOrderID}/tags PATCH /v1/prodorders/{ProductionOrderID}/tasks PATCH /v1/prodorders/assignedto PATCH /v1/prodorders/plannedstart PATCH /v1/prodorders/sequencenumber PATCH /v1/prodorders/status

ProductionOrderPhaseModelobject

Property	Type	Required	Details
`phaseID`	`string`	No	nullable
`name`	`string`	No	nullable
`status`	`string`	No	nullable
`phaseType`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`delayDays`	`integer`	No	format: int32
`isDefault`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/productionorderphases/{PhaseID} POST /v1/productionorderphases

ProductionOrderResourceGroupModelobject

Property	Type	Required	Details
`resourceGroupID`	`string`	No	nullable
`defResourceGroupID`	`string`	No	nullable
`name`	`string`	No	nullable
`usage`	`number`	No	format: double

ProductionOrderResourceModelobject

Property	Type	Required	Details
`resourceID`	`string`	No	nullable
`defResourceID`	`string`	No	nullable
`name`	`string`	No	nullable
`acknowledgementUTC`	`string`	No	format: date-time
`acknowledgedByUserID`	`string`	No	nullable
`usage`	`number`	No	format: double

ProductionOrderSlicerModelobject

Property	Type	Required	Details
`assignedToResourceID`	`string`	No	nullable
`status`	`integer`	No	format: int32
`limit`	`integer`	No	format: int32
`tagValue`	`string`	No	nullable
`tagLabel`	`string`	No	nullable
`daysElapsed`	`integer`	No	format: int32
`daysElapsedEnd`	`integer`	No	format: int32
`percentComplete`	`integer`	No	format: int32
`customerID`	`string`	No	nullable
`phase`	`StringFilter`	No
`iDs`	`array of string`	No	nullable

Used by: POST /v1/prodorders POST /v1/prodorders/count POST /v1/prodorders/pages/{Page} POST /v1/prodorders/pages/{Page}/customers POST /v1/prodorders/pages/{Page}/salesorders

ProductionOrderTaskModelobject

Property	Type	Required	Details
`productionOrderTaskID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`number`	`integer`	No	format: int32
`status`	`string`	No	nullable
`planMinutes`	`number`	No	format: double
`timeSetup_min`	`number`	No	format: double
`timeTeardown_min`	`number`	No	format: double
`timeTransfer_min`	`number`	No	format: double
`minMaxWaitDelta_min`	`number`	No	format: double
`plannedStartUTC`	`string`	No	format: date-time
`plannedFinishUTC`	`string`	No	format: date-time
`actualStartUTC`	`string`	No	format: date-time
`actualFinishUTC`	`string`	No	format: date-time
`verifications`	`array of ProductionOrderTaskVerificationModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`resources`	`array of ProductionOrderResourceModel`	No	nullable
`resourceGroups`	`array of ProductionOrderResourceGroupModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

ProductionOrderTaskStatusUpdateRequestobject

Property	Type	Required	Details	Description
`newStatus`	`string`	No	nullable
`forceAdminOverride`	`boolean`	No

Used by: POST /v1/prodorders/{ProductionOrderID}/tasks/{ProductionOrderTaskID}/status

ProductionOrderTaskVerificationModelobject

Property	Type	Required	Details
`entity`	`string`	No	nullable
`target`	`string`	No	nullable
`targetValue`	`string`	No	nullable
`hintImageUrl`	`string`	No	nullable
`helpUrl`	`string`	No	nullable
`isVerified`	`string`	No	nullable

ProductionQueueModelobject

Property	Type	Required	Details
`name`	`string`	No	nullable
`locationID`	`string`	No	nullable
`workCenter`	`string`	No	nullable
`capacity`	`TaskCapacityModel`	No
`tasks`	`array of ProductionOrderTaskModel`	No	nullable
`hoursAvailable`	`number`	No	format: double

ProductionTimeLedgerAuditRowModelobject

A read-only time-ledger repair candidate. Historical records are never changed by this report.

Property	Type	Required	Details
`eventID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`productionOrderTaskID`	`string`	No	nullable
`userID`	`string`	No	nullable
`taskName`	`string`	No	nullable
`taskNumber`	`integer`	No	format: int32
`status`	`string`	No	nullable
`clockInUTC`	`string`	No	format: date-time
`clockOutUTC`	`string`	No	format: date-time
`durationMinutes`	`number`	No	format: double nullable
`qualityStatus`	`string`	No	nullable
`detail`	`string`	No	nullable

Used by: GET /v1/events/prodorders/invalid-time

ProductMaintainerModelobject

Property	Type	Required	Details	Description
`userID`	`string`	No	nullable

ProductModelobject

Property	Type	Required	Details
`productID`	`string`	No	nullable
`name`	`string`	No	nullable
`productName`	`string`	No	nullable
`versionLabel`	`string`	No	nullable
`familyID`	`string`	No	nullable
`showSmartQuoteProdOrder`	`string`	No	nullable
`diagnosticTreeID`	`string`	No	nullable
`serializationRequired`	`string`	No	nullable
`allowSalesQuotes`	`string`	No	nullable
`allowSalesOrders`	`string`	No	nullable
`allowTroubleReports`	`string`	No	nullable
`showPriceSummary`	`string`	No	nullable
`storeVisible`	`string`	No	nullable
`storeShowPricing`	`string`	No	nullable
`restrictToCustomerIDs`	`array of string`	No	nullable
`imageBase64`	`string`	No	nullable
`images`	`array of ProductImageModel`	No	nullable
`warrantyDays`	`integer`	No	format: int32
`standardLeadTimeDays`	`integer`	No	format: int32
`maxDaysAllowed`	`integer`	No	format: int32
`isActive`	`string`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`pricingComponents`	`array of string`	No	nullable
`priceRounding`	`RoundingOption`	No
`tags`	`array of TagModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`maintainers`	`array of ProductMaintainerModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/products/{ProductID} PATCH /v1/products/{ProductID}/image PATCH /v1/products/{ProductID}/images PATCH /v1/products/{ProductID}/Links PATCH /v1/products/{ProductID}/notes PATCH /v1/products/{ProductID}/store PATCH /v1/products/{ProductID}/tags PUT /v1/products

ProductSetupAiApplyResultModelobject

Property	Type	Required	Details
`requestID`	`string`	No	nullable
`deletedPages`	`integer`	No	format: int32
`deletedAttributes`	`integer`	No	format: int32
`deletedRuleGroups`	`integer`	No	format: int32
`deletedRules`	`integer`	No	format: int32
`createdPages`	`integer`	No	format: int32
`createdAttributes`	`integer`	No	format: int32
`createdRuleGroups`	`integer`	No	format: int32
`createdRules`	`integer`	No	format: int32
`deletedEvents`	`integer`	No	format: int32
`createdEvents`	`integer`	No	format: int32
`elapsedMs`	`integer`	No	format: int64

Used by: POST /v1/products/{productID}/ai/apply

ProductSnapshotModelobject

Property	Type	Required	Details
`snapshotID`	`string`	No	nullable
`productID`	`string`	No	nullable
`status`	`string`	No	nullable
`focus`	`string`	No	nullable
`description`	`string`	No	nullable
`attributes`	`array of LineItemAttrModel`	No	nullable
`tasks`	`array of ProductSnapshotTaskModel`	No	nullable
`pages`	`array of DefinitionPageModel`	No	nullable
`rules`	`array of DefinitionRuleModel`	No	nullable
`comments`	`string`	No	nullable
`sendToUserID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/products/{ProductID}/snapshots/{SnapshotID} PUT /v1/products/{ProductID}/snapshots

ProductSnapshotTaskModelobject

Property	Type	Required	Details
`task`	`LineItemTaskModel`	No
`newPosition`	`string`	No	nullable
`newProcess`	`string`	No	nullable
`newTime`	`string`	No	nullable
`exclude`	`string`	No	nullable

ProductTakeRateAnalysisModelobject

Property	Type	Required	Details
`takeRateAnalysisID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`productID`	`string`	No	nullable
`name`	`string`	No	nullable
`status`	`string`	No	nullable
`lowVolume`	`number`	No	format: double
`expectedVolume`	`number`	No	format: double
`highVolume`	`number`	No	format: double
`safetyStockPercent`	`number`	No	format: double
`webhookUrl`	`string`	No	nullable
`options`	`array of ProductTakeRateOptionModel`	No	nullable
`projections`	`array of ProductTakeRateItemProjectionModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/products/{productID}/take-rate-analyses/{analysisID} PUT /v1/products/{productID}/take-rate-analyses

ProductTakeRateItemProjectionModelobject

Property	Type	Required	Details
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`onHand`	`number`	No	format: double nullable
`minimumOrderQuantity`	`number`	No	format: double
`minimumOrderQuantityIsAssumed`	`boolean`	No
`leadTimeDays`	`integer`	No	format: int32
`leadTimeIsAssumed`	`boolean`	No
`lowDemand`	`number`	No	format: double
`expectedDemand`	`number`	No	format: double
`highDemand`	`number`	No	format: double
`expectedRecommendedStock`	`number`	No	format: double
`expectedNetInventory`	`number`	No	format: double nullable

ProductTakeRateOptionModelobject

Property	Type	Required	Details
`attributeName`	`string`	No	nullable
`value`	`string`	No	nullable
`takeRatePercent`	`number`	No	format: double
`key`	`string`	No	nullable

PromotionModelobject

Property	Type	Required	Details
`lineItemID`	`string`	No	nullable
`lineNumber`	`integer`	No	format: int32
`productID`	`string`	No	nullable
`fingerPrint`	`string`	No	nullable
`sourceDocumentID`	`string`	No	nullable
`effectiveSourceDocumentID`	`string`	No	nullable
`sourceLineItemID`	`string`	No	nullable
`isBatchLine`	`boolean`	No
`batchID`	`string`	No	nullable
`batchChargeLineID`	`string`	No	nullable
`batchSourceLineItemIDs`	`array of string`	No	nullable
`hasBatchSourceLineItems`	`boolean`	No
`description`	`string`	No	nullable
`longDescription`	`string`	No	nullable
`baseMaterialsPrice`	`number`	No	format: double
`baseTasksPrice`	`number`	No	format: double
`basePrice`	`number`	No	format: double
`quantity`	`number`	No	format: double
`discount`	`number`	No	format: double
`status`	`string`	No	nullable
`schedulingPriority`	`string`	No	nullable
`schedulingNotes`	`string`	No	nullable
`leadTimeDays`	`integer`	No	format: int32
`leadTimeWeeks`	`number`	No	format: double
`attributes`	`array of LineItemAttrModel`	No	nullable
`tasks`	`array of LineItemTaskModel`	No	nullable
`items`	`array of LineItemItemAndQtyModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`charges`	`array of LineItemChargeModel`	No	nullable
`allowDiscount`	`boolean`	No
`lengthUOM`	`string`	No	nullable
`weightUOM`	`string`	No	nullable
`showSubTotal`	`string`	No	nullable
`serializationRequired`	`string`	No	nullable
`weight`	`number`	No	format: double
`length`	`number`	No	format: double
`width`	`number`	No	format: double
`height`	`number`	No	format: double
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`isDeleted`	`boolean`	No
`deletedUTC`	`string`	No	format: date-time
`deletedByUserID`	`string`	No	nullable
`promotionID`	`string`	No	nullable
`name`	`string`	No	nullable
`discountPercent`	`number`	No	format: double
`salesQuotes`	`array of string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`expirationUTC`	`string`	No	format: date-time

Used by: PATCH /v1/promotions/{PromotionID} POST /v1/promotions

PurchaseOrderPaymentUploadModelobject

Property	Type	Required	Details
`purchaseOrderNumber`	`string`	No	nullable
`fileName`	`string`	No	nullable
`fileBytes`	`string`	No	nullable

Used by: POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/upload

PurchasingWatchHitModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`itemDescription`	`string`	No	nullable
`ruleID`	`string`	No	nullable
`ruleName`	`string`	No	nullable
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`referenceNumber`	`string`	No	nullable
`detectedUTC`	`string`	No	format: date-time

Used by: GET /v1/purchasing/watchlist

PurchasingWatchRuleModelobject

Property	Type	Required	Details
`ruleID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`name`	`string`	No	nullable
`targetField`	`WatchRuleTargetField`	No
`operator`	`WatchRuleOperator`	No
`value`	`string`	No	nullable
`isActive`	`boolean`	No
`createdUTC`	`string`	No	format: date-time

Used by: POST /v1/purchasing/rules PUT /v1/purchasing/rules/{id}

QualityAssetCalibrationModelobject

Property	Type	Required	Details
`calibrationID`	`string`	No	nullable
`description`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

QualityAssetModelobject

Property	Type	Required	Details
`assetID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`category`	`string`	No	nullable
`isActive`	`string`	No	nullable
`calibrations`	`array of QualityAssetCalibrationModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`attributes`	`object`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`dateNext`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/assets/{AssetID} PATCH /v1/quality/assets/{AssetID}/Notes POST /v1/quality/assets

QualityAuditFindingModelobject

Property	Type	Required	Details
`findingID`	`string`	No	nullable
`description`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

QualityAuditModelobject

Property	Type	Required	Details
`auditID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`findings`	`array of QualityAuditFindingModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`dateNext`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/audits/{AuditID} PATCH /v1/quality/audits/{AuditID}/findings PATCH /v1/quality/audits/{AuditID}/notes POST /v1/quality/audits

QualityCapaModelobject

Property	Type	Required	Details
`qualityCapaID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`status`	`string`	No	nullable
`teamUserIDs`	`array of string`	No	nullable
`phase1Notes`	`array of NoteModel`	No	nullable
`phase2Notes`	`array of NoteModel`	No	nullable
`phase3Notes`	`array of NoteModel`	No	nullable
`phase4Notes`	`array of NoteModel`	No	nullable
`phase5Notes`	`array of NoteModel`	No	nullable
`phase6Notes`	`array of NoteModel`	No	nullable
`phase7Notes`	`array of NoteModel`	No	nullable
`phase8Notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/capa/{QualityCapaID} PATCH /v1/quality/capa/{QualityCapaID}/Phases/{Phase}/Notes POST /v1/quality/capa

QualityChangeModelobject

Property	Type	Required	Details
`changeID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/changes/{ChangeID} PATCH /v1/quality/changes/{ChangeID}/Notes POST /v1/quality/changes

QualityDocumentModelobject

Property	Type	Required	Details
`documentID`	`string`	No	nullable
`locationIDs`	`array of string`	No	nullable
`name`	`string`	No	nullable
`area`	`string`	No	nullable
`fileName`	`string`	No	nullable
`status`	`string`	No	nullable
`revision`	`integer`	No	format: int32
`tags`	`array of TagModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/documents/{DocumentID} PATCH /v1/quality/documents/{DocumentID}/notes

QualityDocumentUploadModelobject

Property	Type	Required	Details
`document`	`QualityDocumentModel`	No
`fileName`	`string`	No	nullable
`fileBytes`	`string`	No	nullable

Used by: POST /v1/quality/documents/add

QualityNcrModelobject

Property	Type	Required	Details
`qualityNcrID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`status`	`string`	No	nullable
`keyType`	`string`	No	nullable
`keyID`	`string`	No	nullable
`assignmentHistory`	`array of AssignmentHistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/quality/ncr/{QualityNcrID} PATCH /v1/quality/ncr/{QualityNcrID}/Assignment PATCH /v1/quality/ncr/{QualityNcrID}/Notes POST /v1/quality/ncr

QueryTestModelobject

Property	Type	Required	Details	Description
`productID`	`string`	No	nullable
`attributesAndValues`	`object`	No	nullable

Used by: POST /v1/attributes/{AttributeID}/queries/test

QueryValidValuesModelobject

Property	Type	Required	Details
`name`	`string`	No	nullable
`xml`	`string`	No	nullable
`sql`	`string`	No	nullable
`catalogAttribute`	`string`	No	nullable
`catalogFilters`	`array of DefinitionAttributeAttrAndValue`	No	nullable
`units`	`string`	No	nullable
`error`	`string`	No	nullable
`catalogLookup`	`CatalogLookupDefinitionModel`	No

RecordTextIntegerModelobject

Property	Type	Required	Details
`x`	`string`	No	nullable
`yInt`	`integer`	No	format: int32
`y`	`number`	No	format: double

Used by: POST /v1/salesorders/analysis/createdon POST /v1/salesorders/analysis/status POST /v1/salesquotes/analysis/createdby POST /v1/salesquotes/analysis/createdon POST /v1/salesquotes/analysis/phase POST /v1/salesquotes/analysis/status

ReferenceModelobject

Property	Type	Required	Details
`referenceID`	`string`	No	nullable
`productID`	`string`	No	nullable
`sourceID`	`string`	No	nullable
`sourceType`	`string`	No	nullable
`targetID`	`string`	No	nullable
`targetType`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

RegressionModelobject

Property	Type	Required	Details
`modelID`	`string`	No	nullable
`name`	`string`	No	nullable
`productIDs`	`array of string`	No	nullable
`constant`	`RegressionModelTerm_CONSTANT`	No
`termsNUM`	`array of RegressionModelTerm_NUM`	No	nullable
`termsBPVNUM`	`array of RegressionModelTerm_BPVNUM`	No	nullable
`termsBPVTEXT`	`array of RegressionModelTerm_BPVTEXT`	No	nullable
`operation`	`string`	No	nullable

RegressionModelTerm_BPVNUMobject

Property	Type	Required	Details
`termType`	`string`	No	nullable
`attribute`	`string`	No	nullable
`comment`	`string`	No	nullable
`coefficient`	`number`	No	format: double
`min`	`number`	No	format: double
`max`	`number`	No	format: double

RegressionModelTerm_BPVTEXTobject

Property	Type	Required	Details
`termType`	`string`	No	nullable
`attribute`	`string`	No	nullable
`comment`	`string`	No	nullable
`coefficient`	`number`	No	format: double
`level`	`string`	No	nullable
`isExactMatch`	`boolean`	No

RegressionModelTerm_CONSTANTobject

Property	Type	Required	Details	Description
`comment`	`string`	No	nullable
`coefficient`	`number`	No	format: double

RegressionModelTerm_NUMobject

Property	Type	Required	Details
`termType`	`string`	No	nullable
`attribute`	`string`	No	nullable
`comment`	`string`	No	nullable
`coefficient`	`number`	No	format: double
`operation`	`string`	No	nullable

ReleaseNoteApiModelobject

Property	Type	Required	Details
`date`	`string`	No	nullable
`title`	`string`	No	nullable
`markdown`	`string`	No	nullable

Used by: GET /v1/releasenotes GET /v1/releasenotes/{date}

RepairSummaryTemplateModelobject

Property	Type	Required	Details
`templateID`	`string`	No	nullable
`productID`	`string`	No	nullable
`name`	`string`	No	nullable
`template`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/service/repairsummary/templates/{TemplateID} POST /v1/service/repairsummary/templates

ResourceCapacityConstraintModelobject

Property	Type	Required	Details	Description
`constraintType`	`string`	No	nullable
`constraintLimit`	`integer`	No	format: int32

ResourceCapacityModelobject

Property	Type	Required	Details	Description
`capacityType`	`string`	No	nullable
`constraint`	`ResourceCapacityConstraintModel`	No

ReviewStatusinteger

RoundingOptioninteger

SalesOpportunityModelobject

Property	Type	Required	Details
`opportunityID`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`contactName`	`string`	No	nullable
`contactEmail`	`string`	No	nullable
`contactMobile`	`string`	No	nullable
`title`	`string`	No	nullable
`url`	`string`	No	nullable
`industryDescription`	`string`	No	nullable
`customerID`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`status`	`SalesOpportunityStatus`	No
`probabilityOfWinning`	`integer`	No	format: int32
`estimatedRevenue`	`number`	No	format: double
`expectedBookingDateUTC`	`string`	No	format: date-time
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`people`	`array of PersonModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/salesfunnel/{OpportunityID} PATCH /v1/salesfunnel/{OpportunityID}/notes PATCH /v1/salesfunnel/{OpportunityID}/people PATCH /v1/salesfunnel/{OpportunityID}/tags PUT /v1/salesfunnel

SalesOpportunityStatusinteger

Used by: GET /v1/salesfunnel/count GET /v1/salesfunnel/pages/{page}

SalesOrderAuditSlicerModelobject

Property	Type	Required	Details
`salesOrderID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`dateMin`	`string`	No	format: date-time
`dateMax`	`string`	No	format: date-time

Used by: POST /v1/audit/salesorders/status

SalesOrderDpasModelobject

Property	Type	Required	Details
`isDPAS`	`boolean`	No
`dpasRating`	`string`	No	nullable
`dpasPriority`	`string`	No	nullable

SalesOrderFinishDateModelobject

Property	Type	Required	Details	Description
`salesOrderID`	`string`	No	nullable
`finishDate`	`string`	No	format: date-time

Used by: POST /v1/salesorders/finishdates

SalesOrderModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`billTo`	`CustomerBillToModel`	No
`shipTo`	`CustomerShipToModel`	No
`endCustomer`	`EndCustomerModel`	No
`contacts`	`array of PersonModel`	No	nullable
`status`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`teamID`	`string`	No	nullable
`payment`	`SalesOrderPaymentOptionsModel`	No
`currencyID`	`string`	No	nullable
`currency`	`CurrencyModel`	No
`discountPercent`	`number`	No	format: double
`confirmedDate`	`string`	No	format: date-time
`requestedDate`	`string`	No	format: date-time
`daysElapsed`	`number`	No	format: double
`slaCurrentBin`	`SlaBin`	No
`slaMode`	`SlaMode`	No
`slaLastEvaluatedUTC`	`string`	No	format: date-time
`delivery`	`DeliveryModel`	No
`options`	`SalesOrderOptionsModel`	No
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time
`lineItems`	`array of LineItemModel`	No	nullable
`items`	`array of ItemAndQtyModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`changeOrders`	`array of ChangeOrderModel`	No	nullable

SalesOrderOptionsModelobject

Property	Type	Required	Details	Description
`defaultTemplateID`	`string`	No	nullable
`dpas`	`SalesOrderDpasModel`	No

SalesOrderPaymentMethodinteger

SalesOrderPaymentOptionsinteger

SalesOrderPaymentOptionsModelobject

Property	Type	Required	Details
`method`	`SalesOrderPaymentMethod`	No
`status`	`SalesQuotePaymentStatus`	No
`statusUpdatedUTC`	`string`	No	format: date-time
`paymentType`	`string`	No	nullable
`purchaseOrderNumber`	`string`	No	nullable
`purchaseOrderDocumentID`	`string`	No	nullable
`purchaseOrderDateUTC`	`string`	No	format: date-time
`terms`	`string`	No	nullable
`creditCardLast4`	`string`	No	nullable
`creditCardBrand`	`string`	No	nullable
`paymentTokenID`	`string`	No	nullable

SalesOrderProductionComparisonBomModelobject

Property	Type	Required	Details
`salesOrderItemID`	`string`	No	nullable
`productionOrderItemID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`itemDescription`	`string`	No	nullable
`salesOrderQuantity`	`number`	No	format: double
`productionOrderQuantity`	`number`	No	format: double
`salesOrderUnitCost`	`number`	No	format: double
`productionOrderUnitCost`	`number`	No	format: double
`salesOrderExtendedCost`	`number`	No	format: double
`productionOrderExtendedCost`	`number`	No	format: double
`comparisonStatus`	`string`	No	nullable

SalesOrderProductionComparisonLineModelobject

Property	Type	Required	Details
`comparisonLineID`	`string`	No	nullable
`salesOrderLineItemID`	`string`	No	nullable
`productID`	`string`	No	nullable
`productNumber`	`string`	No	nullable
`productDescription`	`string`	No	nullable
`productCategory`	`string`	No	nullable
`salesOrderQuantity`	`number`	No	format: double
`productionOrderQuantity`	`number`	No	format: double
`revenue`	`number`	No	format: double
`plannedLaborMinutes`	`number`	No	format: double
`actualLaborMinutes`	`number`	No	format: double
`plannedLaborCost`	`number`	No	format: double
`actualLaborCost`	`number`	No	format: double
`plannedBomCost`	`number`	No	format: double
`actualBomCost`	`number`	No	format: double
`router`	`array of SalesOrderProductionComparisonRouterModel`	No	nullable
`bom`	`array of SalesOrderProductionComparisonBomModel`	No	nullable

SalesOrderProductionComparisonModelobject

Property	Type	Required	Details
`comparisonID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`salesOrderNumber`	`string`	No	nullable
`customerID`	`string`	No	nullable
`customerName`	`string`	No	nullable
`status`	`string`	No	nullable
`salesOrderCompletedUTC`	`string`	No	format: date-time
`generatedUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time
`generatedByUserID`	`string`	No	nullable
`sourceFingerprint`	`string`	No	nullable
`currencyID`	`string`	No	nullable
`revenue`	`number`	No	format: double
`plannedLaborMinutes`	`number`	No	format: double
`actualLaborMinutes`	`number`	No	format: double
`plannedLaborCost`	`number`	No	format: double
`actualLaborCost`	`number`	No	format: double
`plannedBomCost`	`number`	No	format: double
`actualBomCost`	`number`	No	format: double
`lines`	`array of SalesOrderProductionComparisonLineModel`	No	nullable

Used by: PATCH /v1/salesorders/analysis/production-comparisons/{id} PUT /v1/salesorders/analysis/production-comparisons

SalesOrderProductionComparisonRouterModelobject

Property	Type	Required	Details
`salesOrderTaskID`	`string`	No	nullable
`productionOrderTaskID`	`string`	No	nullable
`taskNumber`	`integer`	No	format: int32
`taskName`	`string`	No	nullable
`salesOrderPlanMinutes`	`number`	No	format: double
`productionOrderPlanMinutes`	`number`	No	format: double
`actualMinutes`	`number`	No	format: double
`hourlyRate`	`number`	No	format: double
`hourlyRateSource`	`string`	No	nullable
`plannedLaborCost`	`number`	No	format: double
`actualLaborCost`	`number`	No	format: double
`planVarianceMinutes`	`number`	No	format: double
`actualVarianceMinutes`	`number`	No	format: double
`comparisonStatus`	`string`	No	nullable

SalesOrderProductionComparisonSlicerModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`productID`	`string`	No	nullable
`category`	`string`	No	nullable
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32
`dateFromUTC`	`string`	No	format: date-time nullable
`dateToUTC`	`string`	No	format: date-time nullable
`page`	`integer`	No	format: int32
`recordsPerPage`	`integer`	No	format: int32

Used by: POST /v1/salesorders/analysis/production-comparisons POST /v1/salesorders/analysis/production-comparisons/count

SalesOrderProfitabilityExportResponseModelobject

Property	Type	Required	Details	Description
`exported`	`integer`	No	format: int32
`resultFileName`	`string`	No	nullable
`resultUrl`	`string`	No	nullable
`logFileName`	`string`	No	nullable
`logUrl`	`string`	No	nullable
`calculationLog`	`string`	No	nullable	Optional inline log for the export view; supplied only when includeLog=true.

Used by: GET /v1/salesorders/export/profitability

SalesOrderSlaModelobject

Property	Type	Required	Details
`salesOrderID`	`string`	No	nullable
`number`	`string`	No	nullable
`daysElapsed`	`number`	No	format: double
`customerID`	`string`	No	nullable
`customerName`	`string`	No	nullable
`ceiling`	`integer`	No	format: int32
`diff`	`integer`	No	format: int32
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`createdYear`	`integer`	No	format: int32
`createdMonth`	`integer`	No	format: int32
`productID`	`string`	No	nullable
`productName`	`string`	No	nullable

Used by: POST /v1/salesorders/sla

SalesOrderSlicerModelobject

Property	Type	Required	Details
`status`	`string`	No	nullable
`created`	`string`	No	nullable
`customerID`	`string`	No	nullable
`productID`	`string`	No	nullable
`teamID`	`string`	No	nullable
`havingAttributeName`	`string`	No	nullable
`havingTaskName`	`string`	No	nullable
`daysElapsed`	`integer`	No	format: int32
`daysElapsedEnd`	`integer`	No	format: int32
`createdYear`	`integer`	No	format: int32
`createdMonth`	`integer`	No	format: int32
`sortBy`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

Used by: POST /v1/salesorders POST /v1/salesorders/analysis/createdon POST /v1/salesorders/analysis/status POST /v1/salesorders/count POST /v1/salesorders/export/lineitems POST /v1/salesorders/export/summary POST /v1/salesorders/pages/{page} POST /v1/salesorders/sla

SalesOrdersSettingsModelobject

Property	Type	Required	Details
`paymentRequiredToRelease`	`string`	No	nullable
`allowPurchaseOrders`	`boolean`	No
`showDPAS`	`boolean`	No
`carryOverProductionOrderAssignedResourceID`	`boolean`	No

SalesOrderStatusUpdateModelobject

Property	Type	Required	Details	Description
`status`	`string`	No	nullable

Used by: PATCH /v1/salesorders/{SalesOrderID}/status

SalesOrderWorkModelobject

Property	Type	Required	Details	Description
`salesOrder`	`SalesOrderModel`	No
`prodOrders`	`array of ProductionOrderModel`	No	nullable

Used by: GET /v1/salesorders/schedule GET /v1/salesorders/work

SalesQuoteAnalysisLineModelobject

Property	Type	Required	Details
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32
`monthLabel`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdBy`	`string`	No	nullable
`smartQuoteCount`	`integer`	No	format: int32
`skuCount`	`integer`	No	format: int32
`customCount`	`integer`	No	format: int32

Used by: POST /v1/salesquotes/analysis/lines

SalesQuoteAuditSlicerModelobject

Property	Type	Required	Details
`salesQuoteID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`dateMin`	`string`	No	format: date-time
`dateMax`	`string`	No	format: date-time

Used by: POST /v1/audit/salesquotes/phase POST /v1/audit/salesquotes/status

SalesQuoteEmailLogModelobject

Property	Type	Required	Details
`logID`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`message`	`EmailMessageModel`	No
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/salesquotes/logs/email

SalesQuoteIncotermModelobject

Property	Type	Required	Details
`termID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`location`	`string`	No	nullable
`effectiveYear`	`integer`	No	format: int32

SalesQuoteIndexPageModelobject

Property	Type	Required	Details
`salesQuotes`	`array of SalesQuoteModel`	No	nullable
`customers`	`array of CustomerModel`	No	nullable
`totalRecords`	`integer`	No	format: int32

Used by: POST /v1/salesquotes/index/pages/{page}

SalesQuoteModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`status`	`string`	No	nullable
`number`	`string`	No	nullable
`description`	`string`	No	nullable
`additionalNotes`	`string`	No	nullable
`teamID`	`string`	No	nullable
`customerID`	`string`	No	nullable
`customer`	`CustomerBillToModel`	No
`billTo`	`CustomerBillToModel`	No
`contacts`	`array of PersonModel`	No	nullable
`documents`	`array of DocumentModel`	No	nullable
`incoterm`	`SalesQuoteIncotermModel`	No
`discountPercent`	`number`	No	format: double
`currencyID`	`string`	No	nullable
`currency`	`CurrencyModel`	No
`paymentTerms`	`string`	No	nullable
`payment`	`SalesOrderPaymentOptionsModel`	No
`leadTimeWeeks`	`number`	No	format: double
`validityDays`	`integer`	No	format: int32
`validityStartUTC`	`string`	No	format: date-time
`validUntilUTC`	`string`	No	format: date-time
`pdfGeneratedUTC`	`string`	No	format: date-time
`phase`	`string`	No	nullable
`delivery`	`DeliveryModel`	No
`options`	`SalesQuoteOptionsModel`	No
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time
`lineItems`	`array of LineItemModel`	No	nullable
`items`	`array of ItemAndQtyModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`tags`	`array of TagModel`	No	nullable

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/basics PATCH /v1/salesquotes/{SalesQuoteID}/customer PATCH /v1/salesquotes/{SalesQuoteID}/discount PATCH /v1/salesquotes/{SalesQuoteID}/history PATCH /v1/salesquotes/{SalesQuoteID}/items PATCH /v1/salesquotes/{SalesQuoteID}/lineitems PATCH /v1/salesquotes/{SalesQuoteID}/linenumbering PATCH /v1/salesquotes/{SalesQuoteID}/notes PATCH /v1/salesquotes/{SalesQuoteID}/payment PATCH /v1/salesquotes/{SalesQuoteID}/tags PUT /v1/salesquotes

SalesQuoteOptionsModelobject

Property	Type	Required	Details	Description
`showTotalPrice`	`string`	No	nullable
`defaultTemplateID`	`string`	No	nullable

SalesQuotePaymentStatusinteger

SalesQuotePaymentTokenRequestModelobject

A browser-generated, processor token. It is not evidence that a payment has settled; the payment lifecycle remains Processing until processor confirmation.

Property	Type	Required	Details	Description
`token`	`string`	No	nullable

Used by: POST /v1/salesquotes/{SalesQuoteID}/payment/cc

SalesQuotePhaseUpdateModelobject

Property	Type	Required	Details	Description
`phase`	`string`	No	nullable

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/phase

SalesQuotesAnalysisCustomersModelobject

Property	Type	Required	Details
`records`	`array of RecordTextIntegerModel`	No	nullable
`heatMapData`	`array of HeatMapDataModel`	No	nullable
`xLabels`	`array of string`	No	nullable
`yLabels`	`array of string`	No	nullable

Used by: POST /v1/salesquotes/analysis/customers

SalesQuoteSimulationModelobject

Property	Type	Required	Details
`simulationID`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} POST /v1/salesquotes/{SalesQuoteID}/simulations

SalesQuoteSlicerModelobject

Property	Type	Required	Details
`createdByUserID`	`string`	No	nullable
`status`	`string`	No	nullable
`created`	`string`	No	nullable
`phase`	`string`	No	nullable
`customerID`	`string`	No	nullable
`productID`	`string`	No	nullable
`teamID`	`string`	No	nullable
`paymentStatus`	`SalesQuotePaymentStatus`	No
`createdYear`	`integer`	No	format: int32 nullable
`createdMonth`	`integer`	No	format: int32 nullable
`sortBy`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

SalesQuotesSettingsModelobject

Property	Type	Required	Details
`additionalNotes`	`string`	No	nullable
`quantityDiscountAllowed`	`boolean`	No
`allowSkuQuoting`	`boolean`	No
`allowCustomQuoting`	`boolean`	No
`leaderboardEnabled`	`boolean`	No
`paymentRequired`	`boolean`	No
`publicCheckoutEnabled`	`boolean`	No
`requireCheckoutSignature`	`boolean`	No
`paymentOptions`	`SalesOrderPaymentOptions`	No
`enableMockHelcim`	`boolean`	No
`attributeDescriptionMaxLength`	`integer`	No	format: int32
`releaseMode`	`string`	No	nullable

SalesQuoteStatusUpdateModelobject

Property	Type	Required	Details	Description
`status`	`string`	No	nullable

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/status PATCH /v1/salesquotes/{SalesQuoteID}/status/historical

SalesQuoteUpdateValidityModelobject

Property	Type	Required	Details
`salesQuoteID`	`string`	No	nullable
`validityDays`	`integer`	No	format: int32
`validityStartUTC`	`string`	No	format: date-time

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/validity

ScheduleResequenceRequestModelobject

Property	Type	Required	Details
`requestID`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`requestedByUserID`	`string`	No	nullable
`requestedUTC`	`string`	No	format: date-time
`reason`	`string`	No	nullable
`status`	`string`	No	nullable
`processedByUserID`	`string`	No	nullable
`processedUTC`	`string`	No	format: date-time nullable

Used by: PATCH /v1/schedule/resequence/requests/{RequestID} POST /v1/schedule/resequence/requests POST /v1/schedule/resequence/requests/create

ScheduleResequenceRequestSlicerModelobject

Property	Type	Required	Details
`status`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`requestedByUserID`	`string`	No	nullable
`limit`	`integer`	No	format: int32

Used by: POST /v1/schedule/resequence/requests/all POST /v1/schedule/resequence/requests/count POST /v1/schedule/resequence/requests/pages/{page}

ScheduleSlicerModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`assignedResourceID`	`string`	No	nullable
`status`	`integer`	No	format: int32
`phase`	`StringFilter`	No
`tagLabel`	`string`	No	nullable
`tagValue`	`string`	No	nullable
`percentComplete`	`integer`	No	format: int32
`daysElapsed`	`integer`	No	format: int32
`daysElapsedEnd`	`integer`	No	format: int32
`plannedStartUTC`	`string`	No	format: date-time nullable
`plannedEndUTC`	`string`	No	format: date-time nullable
`orderBy`	`string`	No	nullable
`order`	`string`	No	nullable

Used by: POST /v1/schedule POST /v1/schedule/count POST /v1/schedule/export POST /v1/schedule/monitor POST /v1/schedule/pages/{page} POST /v1/schedule/queues/export POST /v1/schedule/queues/utilization/export

SchedulingAlgorithmModelobject

Property	Type	Required	Details
`algorithm`	`string`	No	nullable
`attributes`	`array of string`	No	nullable
`batchSize`	`integer`	No	format: int32
`keepLineItemsTogether`	`string`	No	nullable

SerializationSerialNumberModelobject

Property	Type	Required	Details
`serialID`	`string`	No	nullable
`number`	`string`	No	nullable
`customerID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`status`	`string`	No	nullable
`warrantyStartUTC`	`string`	No	format: date-time
`warrantyEndUTC`	`string`	No	format: date-time
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`isWarranty`	`boolean`	No

Used by: PATCH /v1/serialization/{SerialID} PATCH /v1/serialization/{SerialID}/batch PUT /v1/serialization PUT /v1/serialization/batch

ServiceCodeModelobject

Property	Type	Required	Details
`codeID`	`string`	No	nullable
`productID`	`string`	No	nullable
`codeType`	`string`	No	nullable
`category`	`string`	No	nullable
`code`	`string`	No	nullable
`description`	`string`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/service/codes/{CodeID} POST /v1/service/codes

ServiceTicketLineItemModelobject

Property	Type	Required	Details
`lineItemID`	`string`	No	nullable
`serialID`	`string`	No	nullable
`problemReported`	`string`	No	nullable
`salesQuoteID`	`string`	No	nullable
`salesQuoteLineItemID`	`string`	No	nullable
`salesOrderID`	`string`	No	nullable
`salesOrderLineItemID`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable

ServiceTicketModelobject

Property	Type	Required	Details
`ticketID`	`string`	No	nullable
`number`	`string`	No	nullable
`status`	`integer`	No	format: int32
`statusEnum`	`TicketStatus`	No
`customerID`	`string`	No	nullable
`lineItems`	`array of ServiceTicketLineItemModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/service/tickets/{TicketID} PUT /v1/service/tickets PUT /v1/service/tickets/batch

ServiceTicketSlicerModelobject

Property	Type	Required	Details
`status`	`TicketStatus`	No
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32

Used by: POST /v1/service/tickets/pages/{page}

SftpExportFileSettingsModelobject

Property	Type	Required	Details
`enabled`	`boolean`	No
`exportType`	`string`	No	nullable
`remotePath`	`string`	No	nullable
`fileName`	`string`	No	nullable
`fromDateUTC`	`string`	No	format: date-time

SftpExportSettingsModelobject

Property	Type	Required	Details
`enabled`	`boolean`	No
`host`	`string`	No	nullable
`port`	`integer`	No	format: int32
`userName`	`string`	No	nullable
`files`	`array of SftpExportFileSettingsModel`	No	nullable
`intervalMinutes`	`integer`	No	format: int32
`hasPassword`	`boolean`	No

SftpExportUpdateModelobject

Property	Type	Required	Details	Description
`settings`	`SftpExportSettingsModel`	No
`password`	`string`	No	nullable

Used by: POST /v1/instances/{InstanceID}/settings/sftp-export

SlaBininteger

SlackWebhookDefinitionobject

Property	Type	Required	Details
`slackWebhookID`	`string`	No	nullable
`name`	`string`	No	nullable
`webhookUrl`	`string`	No	nullable
`channel`	`string`	No	nullable
`userName`	`string`	No	nullable
`isActive`	`boolean`	No

SlaModeinteger

SmartQuoteVersionModelobject

Property	Type	Required	Details
`versionID`	`string`	No	nullable
`productID`	`string`	No	nullable
`label`	`string`	No	nullable
`state`	`string`	No	nullable
`isReleased`	`boolean`	No
`attributesJSON`	`string`	No	nullable
`rulesJSON`	`string`	No	nullable
`ruleGroupsJSON`	`string`	No	nullable
`itemMappingJSON`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable

Used by: GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID} GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/released POST /v1/instances/{InstanceID}/smartquote/{ProductID}/versions

SmartQuoteVersionStateinteger

SmartQuoteVersionStateUpdateModelobject

Property	Type	Required	Details	Description
`state`	`SmartQuoteVersionState`	No
`isReleased`	`boolean`	No

Used by: PATCH /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID}/state

StateMachineDiagramModelobject

Property	Type	Required	Details	Description
`mermaid`	`string`	No	nullable

Used by: GET /v1/salesorders/statemachines/status GET /v1/salesquotes/statemachines/payment GET /v1/salesquotes/statemachines/status

StoreThemeModelobject

Property	Type	Required	Details
`themeID`	`string`	No	nullable
`storeID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`themeName`	`string`	No	nullable
`templateName`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`settings`	`object`	No	nullable
`isActive`	`boolean`	No
`layoutHtml`	`string`	No	nullable
`homeHtml`	`string`	No	nullable
`cartHtml`	`string`	No	nullable
`checkoutHtml`	`string`	No	nullable
`confirmationHtml`	`string`	No	nullable
`storeDetailHtml`	`string`	No	nullable
`storesHtml`	`string`	No	nullable
`searchHtml`	`string`	No	nullable
`ordersHtml`	`string`	No	nullable
`payHtml`	`string`	No	nullable
`configureHtml`	`string`	No	nullable
`templates`	`object`	No	nullable
`partials`	`object`	No	nullable
`createdUTC`	`string`	No	format: date-time
`updatedUTC`	`string`	No	format: date-time

Used by: GET /v1/stores/{InstanceID}/themes GET /v1/stores/{InstanceID}/themes/{ThemeName}/templates/{TemplateName} POST /v1/stores/{InstanceID}/themes

StringFilterobject

Property	Type	Required	Details
`value`	`string`	No	nullable
`mode`	`FilterMode`	No
`isActive`	`boolean`	No

SupplierModelobject

Property	Type	Required	Details
`supplierID`	`string`	No	nullable
`number`	`string`	No	nullable
`name`	`string`	No	nullable
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`country`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`isApproved`	`string`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`people`	`array of PersonModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`lastUpdatedByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/suppliers/{SupplierID}/basics PATCH /v1/suppliers/{SupplierID}/notes PATCH /v1/suppliers/{SupplierID}/people PUT /v1/suppliers

SupplierPriceBreakModelobject

Property	Type	Required	Details
`breakID`	`string`	No	nullable
`quantityMin`	`number`	No	format: double
`quantityMax`	`number`	No	format: double
`price`	`number`	No	format: double
`cost`	`number`	No	format: double

SupplierProductImportMappingModelobject

Property	Type	Required	Details
`supplierID`	`string`	No	nullable
`itemNumberColumn`	`string`	No	nullable
`supplierItemNumberColumn`	`string`	No	nullable
`costColumn`	`string`	No	nullable
`quantityMinColumn`	`string`	No	nullable
`quantityMaxColumn`	`string`	No	nullable
`uomColumn`	`string`	No	nullable
`leadTimeColumn`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/suppliers/{SupplierID}/itemmapping

TagLabelModelobject

Property	Type	Required	Details
`label`	`string`	No	nullable
`category`	`string`	No	nullable
`dataType`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`isRequired`	`string`	No	nullable
`allowEdit`	`string`	No	nullable
`tagType`	`string`	No	nullable
`validValues`	`array of string`	No	nullable
`labelID`	`string`	No	nullable
`entity`	`string`	No	nullable

Used by: POST /v1/instances/defaulttags POST /v1/setup/defaulttags

TagModelobject

Property	Type	Required	Details
`label`	`string`	No	nullable
`category`	`string`	No	nullable
`dataType`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`isRequired`	`string`	No	nullable
`allowEdit`	`string`	No	nullable
`tagType`	`string`	No	nullable
`validValues`	`array of string`	No	nullable
`tagID`	`string`	No	nullable
`value`	`string`	No	nullable

TaskCapacityConstraintModelobject

Property	Type	Required	Details	Description
`constraintType`	`string`	No	nullable
`constraintLimit`	`integer`	No	format: int32

TaskCapacityModelobject

Property	Type	Required	Details	Description
`capacityType`	`string`	No	nullable
`constraint`	`TaskCapacityConstraintModel`	No

TaskModelUpdateModelobject

Property	Type	Required	Details	Description
`xml`	`string`	No	nullable

Used by: PATCH /v1/tasks/{TaskID}/model/cost PATCH /v1/tasks/{TaskID}/model/time

TeamMemberModelobject

Property	Type	Required	Details
`teamID`	`string`	No	nullable
`userID`	`string`	No	nullable
`role`	`string`	No	nullable
`joinedUTC`	`string`	No	format: date-time

Used by: POST /v1/teams/{TeamID}/members

TeamModelobject

Property	Type	Required	Details
`teamID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`isActive`	`string`	No	nullable
`members`	`array of TeamMemberModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: GET /v1/teams GET /v1/teams/{TeamID} GET /v1/teams/my POST /v1/teams PUT /v1/teams/{TeamID}

TenantGroupMemberModelobject

Property	Type	Required	Details
`memberID`	`string`	No	nullable
`groupID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/instances/groups/{GroupID}/members

TenantGroupModelobject

Property	Type	Required	Details
`groupID`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/instances/groups

TenantProvisioningRequestobject

Property	Type	Required	Details
`tenantID`	`string`	No	nullable
`appID`	`string`	No	nullable
`companyType`	`string`	No	nullable
`tenant`	`InstanceModel`	No

Used by: POST /v1/tenant-provisioning

TenantProvisioningResponseobject

Property	Type	Required	Details	Description
`tenantID`	`string`	No	nullable
`status`	`string`	No	nullable

Used by: POST /v1/tenant-provisioning

TenantProvisioningStatusModelobject

Property	Type	Required	Details
`tenantID`	`string`	No	nullable
`status`	`string`	No	nullable
`lastError`	`string`	No	nullable
`steps`	`array of TenantProvisioningStepStatusModel`	No	nullable

Used by: GET /v1/tenant-provisioning/{tenantId}

TenantProvisioningStepStatusModelobject

Property	Type	Required	Details
`stepName`	`string`	No	nullable
`status`	`string`	No	nullable
`detail`	`string`	No	nullable

TenantSeedRequestobject

Property	Type	Required	Details	Description
`seedProfile`	`string`	No	nullable

Used by: POST /v1/tenants/{tenantId}/seed-runs

TenantSeedResponseobject

Property	Type	Required	Details
`runID`	`string`	No	nullable
`tenantID`	`string`	No	nullable
`seedProfile`	`string`	No	nullable
`status`	`string`	No	nullable

Used by: POST /v1/tenants/{tenantId}/seed-runs

TenantSeedRunStatusModelobject

Property	Type	Required	Details
`runID`	`string`	No	nullable
`tenantID`	`string`	No	nullable
`seedProfile`	`string`	No	nullable
`status`	`string`	No	nullable
`error`	`string`	No	nullable

Used by: GET /v1/tenants/{tenantId}/seed-runs/{runId}

TicketStatusinteger

ToDoModelobject

Property	Type	Required	Details
`toDoID`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`referenceType`	`string`	No	nullable
`status`	`integer`	No	format: int32
`description`	`string`	No	nullable
`scope`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`dueDateUTC`	`string`	No	format: date-time
`createdUTC`	`string`	No	format: date-time
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/todo PUT /v1/todo

TroubleCorrectiveActionModelobject

Property	Type	Required	Details
`action`	`string`	No	nullable
`prevention`	`string`	No	nullable
`failureAnalysis`	`string`	No	nullable
`repairs`	`array of TroubleRepairModel`	No	nullable
`notesText`	`string`	No	nullable
`notesList`	`array of string`	No	nullable

TroubleProfileModelobject

Property	Type	Required	Details
`partNumber`	`string`	No	nullable
`serialNumber`	`string`	No	nullable
`revision`	`string`	No	nullable
`dateOfManufacture`	`string`	No	format: date-time
`dateOfManufactureDate`	`string`	No	nullable
`notes`	`string`	No	nullable

TroubleRepairMaterialModelobject

Property	Type	Required	Details
`materialID`	`string`	No	nullable
`origPartNumber`	`string`	No	nullable
`origDescription`	`string`	No	nullable
`origRevision`	`string`	No	nullable
`origSerialNumber`	`string`	No	nullable
`origNotes`	`string`	No	nullable
`newPartNumber`	`string`	No	nullable
`newDescription`	`string`	No	nullable
`newRevision`	`string`	No	nullable
`newSerialNumber`	`string`	No	nullable
`newNotes`	`string`	No	nullable
`quantity`	`number`	No	format: double
`uom`	`string`	No	nullable
`purchaseOrderNumber`	`string`	No	nullable
`lotNumber`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

TroubleRepairModelobject

Property	Type	Required	Details
`repairID`	`string`	No	nullable
`category`	`string`	No	nullable
`code`	`string`	No	nullable
`description`	`string`	No	nullable
`origPartNumber`	`string`	No	nullable
`origRevision`	`string`	No	nullable
`origSerialNumber`	`string`	No	nullable
`newPartNumber`	`string`	No	nullable
`newRevision`	`string`	No	nullable
`newSerialNumber`	`string`	No	nullable
`newNotes`	`array of NoteModel`	No	nullable
`incidentalMaterials`	`array of TroubleRepairMaterialModel`	No	nullable

TroubleReportModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`reportID`	`string`	No	nullable
`number`	`string`	No	nullable
`status`	`string`	No	nullable
`productionOrderID`	`string`	No	nullable
`serviceTicketID`	`string`	No	nullable
`serviceTicketLineItemID`	`string`	No	nullable
`problemReported`	`string`	No	nullable
`repairSummary`	`string`	No	nullable
`profileIncoming`	`TroubleProfileModel`	No
`profileOutgoing`	`TroubleProfileModel`	No
`symptoms`	`array of TroubleSymptomModel`	No	nullable
`documentReferences`	`array of DocumentReferenceModel`	No	nullable
`links`	`array of DocumentLinkModel`	No	nullable
`notes`	`array of NoteModel`	No	nullable
`tags`	`array of TagModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`audit`	`array of AuditRecordModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/service/troublereports/{ReportID} PUT /v1/service/troublereports

TroubleReportSlicerModelobject

Property	Type	Required	Details
`status`	`string`	No	nullable
`customerID`	`string`	No	nullable
`productID`	`string`	No	nullable
`searchFor`	`string`	No	nullable
`limit`	`integer`	No	format: int32

Used by: POST /v1/service/troublereports/count POST /v1/service/troublereports/customers POST /v1/service/troublereports/pages/{page} POST /v1/service/troublereports/prodorders/pages/{page} POST /v1/service/troublereports/salesorders/pages/{page}

TroubleSymptomModelobject

Property	Type	Required	Details
`symptomID`	`string`	No	nullable
`category`	`string`	No	nullable
`code`	`string`	No	nullable
`description`	`string`	No	nullable
`causeCategory`	`string`	No	nullable
`causeCode`	`string`	No	nullable
`causeDescription`	`string`	No	nullable
`correctiveAction`	`TroubleCorrectiveActionModel`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

UpdateCreatedByModelobject

Property	Type	Required	Details	Description
`origUserID`	`string`	No	nullable
`newUserID`	`string`	No	nullable

Used by: PATCH /v1/prodorders/createdby PATCH /v1/salesorders/createdby PATCH /v1/salesquotes/createdby PATCH /v1/service/reports/createdby

UserProfileBaseModelobject

Property	Type	Required	Details
`profileID`	`string`	No	nullable
`userID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`timeZoneID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`notificationPreferences`	`NotificationPreferencesModel`	No
`webInterfacePreferences`	`object`	No	nullable

UserTenantAccessModelobject

Property	Type	Required	Details
`accessID`	`string`	No	nullable
`userID`	`string`	No	nullable
`instanceID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`apiKey`	`string`	No	nullable
`roles`	`array of string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable

UserTourModelobject

Property	Type	Required	Details
`tourID`	`string`	No	nullable
`completed`	`boolean`	No
`completedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/tours/{TourID}

VerticalModelobject

Property	Type	Required	Details
`verticalID`	`string`	No	nullable
`name`	`string`	No	nullable
`targetMarginPercent`	`number`	No	format: double nullable
`isActive`	`boolean`	No

Used by: GET /v1/verticals GET /v1/verticals/{VerticalID} POST /v1/verticals PUT /v1/verticals/{VerticalID}

VideoModelobject

Property	Type	Required	Details
`videoID`	`string`	No	nullable
`description`	`string`	No	nullable
`url`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

ViewHistoryModelobject

Property	Type	Required	Details
`viewID`	`string`	No	nullable
`userID`	`string`	No	nullable
`controller`	`string`	No	nullable
`keyID`	`string`	No	nullable
`subKeyID`	`string`	No	nullable
`description`	`string`	No	nullable
`route`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

WatchRuleOperatorinteger

WatchRuleTargetFieldinteger

WebhookLogModelobject

Property	Type	Required	Details
`webhookLogID`	`string`	No	nullable
`webhookID`	`string`	No	nullable
`entity`	`string`	No	nullable
`entityID`	`string`	No	nullable
`event`	`string`	No	nullable
`baseUrl`	`string`	No	nullable
`resource`	`string`	No	nullable
`result`	`string`	No	nullable
`detail`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`responseStatusCodeText`	`string`	No	nullable
`responseStatusCode`	`integer`	No	format: int32 nullable
`responseBody`	`string`	No	nullable
`requestPayload`	`string`	No	nullable
`requestHeaders`	`string`	No	nullable
`durationMs`	`integer`	No	format: int64

Used by: POST /v1/webhooks/logs

WebhookLogSlicerModelobject

Property	Type	Required	Details
`entity`	`string`	No	nullable
`event`	`string`	No	nullable
`year`	`integer`	No	format: int32
`month`	`integer`	No	format: int32
`page`	`integer`	No	format: int32

Used by: POST /v1/webhooks/logs/count POST /v1/webhooks/logs/pages

WebhookModelobject

Property	Type	Required	Details
`webhookID`	`string`	No	nullable
`entity`	`string`	No	nullable
`event`	`string`	No	nullable
`description`	`string`	No	nullable
`baseUrl`	`string`	No	nullable
`resource`	`string`	No	nullable
`method`	`string`	No	nullable
`headersJson`	`string`	No	nullable
`secret`	`string`	No	nullable
`slackSend`	`boolean`	No
`slackWebhookUrl`	`string`	No	nullable
`slackUserName`	`string`	No	nullable
`slackChannel`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/webhooks/{WebHookID} POST /v1/webhooks

WorkDayModelobject

Property	Type	Required	Details
`workDayID`	`string`	No	nullable
`name`	`string`	No	nullable
`dayOfWeek`	`integer`	No	format: int32
`hours`	`array of WorkTimeModel`	No	nullable

WorkInstructionModelobject

Property	Type	Required	Details
`instructionID`	`string`	No	nullable
`productID`	`string`	No	nullable
`description`	`string`	No	nullable
`revision`	`string`	No	nullable
`steps`	`array of WorkInstructionStepModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/workinstructions/{InstructionID} PUT /v1/workinstructions

WorkInstructionStepModelobject

Property	Type	Required	Details
`stepID`	`string`	No	nullable
`languageID`	`string`	No	nullable
`sortOrder`	`integer`	No	format: int32
`description`	`string`	No	nullable
`instruction`	`string`	No	nullable
`images`	`array of ImageModel`	No	nullable
`videos`	`array of VideoModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

WorkTimeModelobject

Property	Type	Required	Details
`workTimeID`	`string`	No	nullable
`timeStart`	`string`	No	format: date-time
`timeStop`	`string`	No	format: date-time

XmlTemplateModelobject

Property	Type	Required	Details
`templateID`	`string`	No	nullable
`name`	`string`	No	nullable
`appliesTo`	`string`	No	nullable
`template`	`string`	No	nullable
`isActive`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/xml/templates/{TemplateID} POST /v1/xml/templates

Example request

curl --request GET "https://api.velosity.one/v1/customer/accounts/{UserID}" \
  --header "X-APIKEY: YOUR_API_KEY"using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.velosity.one/v1/customer/accounts/{UserID}");
request.Headers.Add("X-APIKEY", "YOUR_API_KEY");

var response = await client.SendAsync(request);