Documentation feedback

Was this helpful?

API reference

Forge 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

NameInTypeRequiredDetailsDescription
UserIDpathstringYes The `UserID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
EmailAddresspathstringYes The `EmailAddress` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
MobileNumberpathstringYes The `MobileNumber` route parameter. Required.

Responses

200 OK

AccountsLite

GET /v1/accounts/lite #

Parameters

NameInTypeRequiredDetailsDescription
IsActivequerystringNo default: * The `IsActive` query-string parameter. Optional; defaults to `*`.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
UserIDpathstringYes The `UserID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AnnouncementIDpathstringYes The `AnnouncementID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PolicyIDpathstringYes The `PolicyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PolicyIDpathstringYes The `PolicyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PolicyIDpathstringYes The `PolicyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/attributes/{AttributeID} #

Parameters

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/attributes/{AttributeID} #

Parameters

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
numberpathstringYes The `number` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EntityIDpathstringYes The `EntityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RuleIDpathstringYes The `RuleID` route parameter. Required.
DesignIDpathstringYes The `DesignID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.
RuleIDpathstringYes The `RuleID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DesignIDpathstringYes The `DesignID` route parameter. Required.
RuleIDpathstringYes The `RuleID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RunIDpathstringYes The `RunID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RunIDpathstringYes The `RunID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RunIDpathstringYes The `RunID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
searchforpathstringYes The `searchfor` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

ChangeAnnouncements

GET /v1/changes/announcements #

Returns upcoming-change announcements authored by this application.

Responses

200 OK application/json 
"example"
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ChangeAnnouncementSourceModel ProblemDetails

CommercialRelationships

POST /v1/commercial-relationships #

Responses

200 OK application/json 
{
  "commercialRelationshipID": "example_001",
  "name": "Example name",
  "relationshipType": "example",
  "sellingEntity": "example",
  "supplyingEntity": "example",
  "agreementID": "example_001",
  "agreementVersion": "example",
  "description": "example"
}

Schemas: CommercialRelationshipModel

GET /v1/commercial-relationships/{relationshipID} #

Parameters

NameInTypeRequiredDetailsDescription
relationshipIDpathstringYes The `relationshipID` route parameter. Required.

Responses

200 OK application/json 
{
  "commercialRelationshipID": "example_001",
  "name": "Example name",
  "relationshipType": "example",
  "sellingEntity": "example",
  "supplyingEntity": "example",
  "agreementID": "example_001",
  "agreementVersion": "example",
  "description": "example"
}

Schemas: CommercialRelationshipModel

PUT /v1/commercial-relationships/{relationshipID} #

Parameters

NameInTypeRequiredDetailsDescription
relationshipIDpathstringYes The `relationshipID` route parameter. Required.

Responses

200 OK application/json 
{
  "commercialRelationshipID": "example_001",
  "name": "Example name",
  "relationshipType": "example",
  "sellingEntity": "example",
  "supplyingEntity": "example",
  "agreementID": "example_001",
  "agreementVersion": "example",
  "description": "example"
}

Schemas: CommercialRelationshipModel

POST /v1/commercial-relationships/{relationshipID}/documents #

Parameters

NameInTypeRequiredDetailsDescription
relationshipIDpathstringYes The `relationshipID` route parameter. Required.

Responses

200 OK application/json 
{
  "documentID": "example_001",
  "name": "Example name",
  "revision": "example",
  "description": "example",
  "fileName": "Example name",
  "contentType": "example",
  "createdByUserID": "example_001",
  "createdUTC": "2026-01-15T12:00:00Z"
}

Schemas: CommercialRelationshipDocumentModel CommercialRelationshipDocumentUploadModel

DELETE /v1/commercial-relationships/{relationshipID}/documents/{documentID} #

Parameters

NameInTypeRequiredDetailsDescription
relationshipIDpathstringYes The `relationshipID` route parameter. Required.
documentIDpathstringYes The `documentID` route parameter. Required.

Responses

200 OK
GET /v1/commercial-relationships/{relationshipID}/documents/{documentID} #

Parameters

NameInTypeRequiredDetailsDescription
relationshipIDpathstringYes The `relationshipID` route parameter. Required.
documentIDpathstringYes The `documentID` route parameter. Required.

Responses

200 OK

Configure

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

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ConfigurationModel ProblemDetails

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

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK application/json 
{
  "key": "example",
  "label": "example",
  "displayOrder": 0,
  "benefits": "example",
  "benefitDefinitions": "example",
  "fences": "example",
  "lineItem": {
    "lineItemID": "example_001",
    "lineNumber": 0,
    "productID": "example_001",
    "workInstructionID": "example_001",
    "workInstructionRevisionID": "example_001",
    "fingerPrint": "example",
    "sourceDocumentID": "example_001",
    "effectiveSourceDocumentID": "example_001"
  }
}
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: ConfigurationLineItemOptionModel ConfigurationLineItemSelectionRequestModel ProblemDetails

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

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CountryIDpathstringYes The `CountryID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
codepathstringYes The `code` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CurrencyIDpathstringYes The `CurrencyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
codepathstringYes The `code` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CurrencyIDpathstringYes The `CurrencyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
codepathstringYes The `code` route parameter. Required.
datequerystringNo format: date-time The `date` query-string parameter.

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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: CustomerMetricsModel

GET /v1/customers/metrics #

Responses

200 OK

CustomerOrders

GET /v1/customerorders #

Responses

200 OK
DELETE /v1/customerorders/{CustomerOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerOrderIDpathstringYes The `CustomerOrderID` route parameter. Required.

Responses

200 OK
GET /v1/customerorders/{CustomerOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerOrderIDpathstringYes The `CustomerOrderID` route parameter. Required.

Responses

200 OK
PATCH /v1/customerorders/{CustomerOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerOrderIDpathstringYes The `CustomerOrderID` route parameter. Required.

Responses

200 OK

Schemas: CustomerOrderModel

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerOrderIDpathstringYes The `CustomerOrderID` route parameter. Required.

Responses

200 OK

Schemas: NoteModel

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

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

Responses

200 OK
GET /v1/customerorders/count #

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
recordsperpagequeryintegerNo format: int32 default: 25 The `recordsperpage` query-string parameter. Optional; defaults to `25`.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

Responses

200 OK

CustomerPeople

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PersonIDpathstringYes The `PersonID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
PersonIDpathstringYes The `PersonID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
PersonIDpathstringYes The `PersonID` route parameter. Required.

Responses

200 OK

Schemas: PersonModel

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

Parameters

NameInTypeRequiredDetailsDescription
PersonIDpathstringYes The `PersonID` route parameter. Required.

Responses

200 OK

Schemas: NoteModel

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

Parameters

NameInTypeRequiredDetailsDescription
emailpathstringYes The `email` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

Responses

200 OK

Customers

GET /v1/customers #

Responses

200 OK
POST /v1/customers #

Responses

200 OK

Schemas: CustomerModel

DELETE /v1/customers/{CustomerID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK
GET /v1/customers/{CustomerID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK
PATCH /v1/customers/{CustomerID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: CustomerModel

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: CustomerModel

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: NoteModel

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: CustomerModel

GET /v1/customers/attributes/export #

Parameters

NameInTypeRequiredDetailsDescription
FormatquerystringNo default: csv enum: csv The `Format` query-string parameter. Optional; defaults to `csv`. Supported values: `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

NameInTypeRequiredDetailsDescription
FormatquerystringNo default: csv enum: csv The `Format` query-string parameter. Optional; defaults to `csv`. Supported values: `csv`.

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/count #

Parameters

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
limitqueryintegerNo format: int32 The `limit` query-string parameter.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
limitqueryintegerNo format: int32 The `limit` query-string parameter.

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

NameInTypeRequiredDetailsDescription
qpathstringYes The `q` route parameter. Required.
limitqueryintegerNo format: int32 default: 2147483647 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

200 OK

Schemas: CustomerShipToModel

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.
ShipToIDpathstringYes The `ShipToID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.
ShipToIDpathstringYes The `ShipToID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.
ShipToIDpathstringYes The `ShipToID` route parameter. Required.

Responses

200 OK
409 Conflict application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: JToken ProblemDetails

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.
ShipToIDpathstringYes The `ShipToID` route parameter. Required.

Responses

200 OK

Schemas: ReassignShipToRequest

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

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
FormatquerystringNo default: csv enum: csv, txt The `Format` query-string parameter. Optional; defaults to `csv`. Supported values: `csv`, `txt`.

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

NameInTypeRequiredDetailsDescription
ImportIDquerystringNo The `ImportID` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 default: 25 The `RecordsPerPage` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
recordcountqueryintegerNo format: int32 default: 25 The `recordcount` query-string parameter. Optional; defaults to `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
DELETE /v1/service/diagnostictrees/{DiagnosticTreeID} #

Parameters

NameInTypeRequiredDetailsDescription
DiagnosticTreeIDpathstringYes The `DiagnosticTreeID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
DiagnosticTreeIDpathstringYes The `DiagnosticTreeID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
DiagnosticTreeIDpathstringYes The `DiagnosticTreeID` route parameter. Required.

Responses

200 OK

Schemas: DiagnosticTreeModel

Discussions

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

Parameters

NameInTypeRequiredDetailsDescription
primaryKeyIdpathstringYes The `primaryKeyId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
primaryKeyIdpathstringYes The `primaryKeyId` route parameter. Required.

Responses

200 OK

Schemas: DiscussionThreadModel

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

Parameters

NameInTypeRequiredDetailsDescription
messageIdpathstringYes The `messageId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
messageIdpathstringYes The `messageId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
messageIdpathstringYes The `messageId` route parameter. Required.

Responses

200 OK

Schemas: DiscussionThreadMessageModel

GET /v1/discussions/threads #

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

200 OK

Schemas: DiscussionThreadModel

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.
pagequeryintegerNo format: int32 default: 1 The `page` query-string parameter. Optional; defaults to `1`. Pages are 1-based.
sizequeryintegerNo format: int32 default: 50 The `size` query-string parameter. Optional; defaults to `50`.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

200 OK

Schemas: DiscussionThreadMessageModel

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.

Responses

200 OK

Schemas: DiscussionParticipantModel

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

Parameters

NameInTypeRequiredDetailsDescription
threadIdpathstringYes The `threadId` route parameter. Required.
userIdpathstringYes The `userId` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/documents/{DocumentID} #

Parameters

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/documents/{DocumentID} #

Parameters

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentTypepathstringYes The `DocumentType` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
recordcountqueryintegerNo format: int32 default: 25 The `recordcount` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
documenttypepathstringYes default: ANY The `documenttype` route parameter. Required.
recordcountqueryintegerNo format: int32 default: 25 The `recordcount` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
EmailIDpathstringYes The `EmailID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/email/{EmailID} #

Parameters

NameInTypeRequiredDetailsDescription
EmailIDpathstringYes The `EmailID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
searchforpathstringYes The `searchfor` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.
SalesQuoteIDquerystringNo The `SalesQuoteID` query-string parameter. Optional; defaults to ``.
SalesOrderIDquerystringNo The `SalesOrderID` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EmployeeIDpathstringYes The `EmployeeID` route parameter. Required.

Responses

200 OK
GET /v1/employees/{EmployeeID} #

Parameters

NameInTypeRequiredDetailsDescription
EmployeeIDpathstringYes The `EmployeeID` route parameter. Required.

Responses

200 OK
PATCH /v1/employees/{EmployeeID} #

Parameters

NameInTypeRequiredDetailsDescription
EmployeeIDpathstringYes The `EmployeeID` route parameter. Required.

Responses

200 OK

Schemas: EmployeeModel

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

Parameters

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 1000 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
EventIDpathstringYes The `EventID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EntityIDpathstringYes The `EntityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: EventSlicerModel ProblemDetails

ForgeAiSetupJobs

GET /v1/forge/ai/jobs #

Parameters

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 50 The `limit` query-string parameter. Optional; defaults to `50`.

Responses

200 OK
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

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

Responses

200 OK application/json 
{
  "succeeded": false,
  "previousState": "example",
  "state": "example",
  "error": "example",
  "allowedCommands": "example"
}

Schemas: ForgeAiTransitionRequestModel ForgeAiTransitionResultModel

ForgeAiSetupSources

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

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

Responses

200 OK
POST /v1/forge/ai/jobs/{jobID}/sources #

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

Responses

200 OK application/json 
{
  "sourceID": "example_001",
  "jobID": "example_001",
  "sourceType": "example",
  "originalFileName": "Example name",
  "url": "example",
  "storageKey": "example",
  "mimeType": "example",
  "checksum": "example"
}

Schemas: ForgeAiSetupSourceModel

DELETE /v1/forge/ai/jobs/{jobID}/sources/{sourceID} #

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.
sourceIDpathstringYes The `sourceID` route parameter. Required.

Responses

200 OK

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

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
preferenceQuotesquerystringNo default: My The `preferenceQuotes` query-string parameter. Optional; defaults to `My`.
preferenceOrdersquerystringNo default: My The `preferenceOrders` query-string parameter. Optional; defaults to `My`.
tourIdquerystringNo The `tourId` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
FileNamequerystringNo The `FileName` query-string parameter.

Responses

200 OK
POST /v1/imports/{ImportID} #

Import a datafile

Parameters

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

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/items/rules #

Returns the machine-readable contract for item import validation.

Responses

200 OK application/json 
{
  "contractVersion": "example",
  "resource": "example",
  "importSemantics": "example",
  "supportedFormats": "example",
  "fields": "example",
  "rules": "example"
}
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemImportRulesModel ProblemDetails

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

200 OK

Schemas: AppForgeSettingsModel

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
featurepathstringYes The `feature` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

200 OK

Schemas: AppForgeSettingsModel

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

200 OK

Schemas: SftpExportUpdateModel

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

200 OK
PATCH /v1/instances/{InstanceID}/type #

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

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: InstanceTypeUpdateRequest ProblemDetails

GET /v1/instances/configurationhistory #

Parameters

NameInTypeRequiredDetailsDescription
ProductIDquerystringNo The `ProductID` query-string parameter.

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

PATCH /v1/instances/gbb-catalog #

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: GbbCatalogModel ProblemDetails

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
GroupIDpathstringYes The `GroupID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
GroupIDpathstringYes The `GroupID` route parameter. Required.

Responses

200 OK

Schemas: TenantGroupMemberModel

InstanceGroups

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
GroupIDpathstringYes The `GroupID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
GroupIDpathstringYes The `GroupID` route parameter. Required.

Responses

200 OK

InstanceInvoices

GET /v1/instance/invoices #

Parameters

NameInTypeRequiredDetailsDescription
StatusquerystringNo default: DRAFT enum: ANY, DRAFT, UNPAID, PAID The `Status` query-string parameter. Optional; defaults to `DRAFT`. Internal constants: `ANY`, `DRAFT`, `UNPAID`, `PAID`.

Responses

200 OK
PUT /v1/instance/invoices #

Responses

200 OK

Schemas: InvoiceModel

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

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

Responses

200 OK

Schemas: InvoiceModel

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

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
qpathstringYes The `q` route parameter. Required.

Responses

200 OK

Instructions

GET /v1/instructions #

Get instructions ByTaskID

Responses

200 OK
GET /v1/instructions/{InstructionID} #

Get by ID

Parameters

NameInTypeRequiredDetailsDescription
InstructionIDpathstringYes The `InstructionID` route parameter. Required.

Responses

200 OK
POST /v1/instructions/{taskid} #

Update

Parameters

NameInTypeRequiredDetailsDescription
taskidpathstringYes The `taskid` route parameter. Required.

Responses

200 OK

Schemas: InstructionModel

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

GetByTaskID

Parameters

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

Responses

200 OK

Integrations

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

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
IntegrationIDpathstringYes The `IntegrationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
IntegrationIDpathstringYes The `IntegrationID` route parameter. Required.

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

Invoices

GET /v1/invoices #

Parameters

NameInTypeRequiredDetailsDescription
StatusquerystringNo default: DRAFT enum: ANY, DRAFT, UNPAID, PAID The `Status` query-string parameter. Optional; defaults to `DRAFT`. Internal constants: `ANY`, `DRAFT`, `UNPAID`, `PAID`.

Responses

200 OK
PUT /v1/invoices #

Responses

200 OK

Schemas: InvoiceModel

GET /v1/invoices/{InvoiceID} #

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

Responses

200 OK
PATCH /v1/invoices/{InvoiceID} #

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

Responses

200 OK

Schemas: InvoiceModel

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

Parameters

NameInTypeRequiredDetailsDescription
InvoiceIDpathstringYes The `InvoiceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

Responses

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

Parameters

NameInTypeRequiredDetailsDescription
qpathstringYes The `q` route parameter. Required.

Responses

200 OK

ItemCompatibility

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

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CompatibilityIDpathstringYes The `CompatibilityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CompatibilityIDpathstringYes The `CompatibilityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CompatibilityIDpathstringYes The `CompatibilityID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemCompatibilityModel ProblemDetails

POST /v1/items/compatibility/{CompatibilityID}/review #

Parameters

NameInTypeRequiredDetailsDescription
CompatibilityIDpathstringYes The `CompatibilityID` route parameter. Required.

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: ItemRelationshipReviewRequest ProblemDetails

GET /v1/items/compatibility/effective #

Parameters

NameInTypeRequiredDetailsDescription
BaseSubjectTypequerystringNo The `BaseSubjectType` query-string parameter.
BaseSubjectIDquerystringNo The `BaseSubjectID` query-string parameter.
RelatedSubjectTypequerystringNo The `RelatedSubjectType` query-string parameter.
RelatedSubjectIDquerystringNo The `RelatedSubjectID` query-string parameter.
ScopequerystringNo The `Scope` query-string parameter.
LimitqueryintegerNo format: int32 The `Limit` query-string parameter.

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

ItemContractPricing

GET /v1/items/contractpricing #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDquerystringNo The `CustomerID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ItemMappingIDpathstringYes The `ItemMappingID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemMappingIDpathstringYes The `ItemMappingID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemMappingIDpathstringYes The `ItemMappingID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
CategoryquerystringNo default: ALL The `Category` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
FormatquerystringNo default: JSON enum: tab, csv, json The `Format` query-string parameter. Optional; defaults to `JSON`. Supported values: `tab`, `csv`, `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
ReplaceExistingquerybooleanNo default: false The `ReplaceExisting` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
AttributesAndValuespathstringYes The `AttributesAndValues` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
CategoryquerystringNo The `Category` query-string parameter.
PagepathintegerYes format: int32 The `Page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SearchForpathstringYes The `SearchFor` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SearchForquerystringNo The `SearchFor` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
FormatquerystringNo default: JSON enum: tab, csv, json The `Format` query-string parameter. Optional; defaults to `JSON`. Supported values: `tab`, `csv`, `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
CategoryquerystringNo default: ALL The `Category` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
ReplaceExistingquerybooleanNo default: false The `ReplaceExisting` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
AttributesAndValuespathstringYes The `AttributesAndValues` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
CategoryquerystringNo The `Category` query-string parameter.
PagepathintegerYes format: int32 The `Page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SearchForpathstringYes The `SearchFor` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SearchForquerystringNo The `SearchFor` query-string parameter.

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

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 2147483647 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ReviewIDpathstringYes The `ReviewID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReviewIDpathstringYes The `ReviewID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReviewIDpathstringYes The `ReviewID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReviewIDpathstringYes The `ReviewID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

Items

GET /v1/items #

Parameters

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 2147483647 The `limit` query-string parameter. Optional; defaults to `2147483647`.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/items #

Creates one item.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel.

Parameters

NameInTypeRequiredDetailsDescription
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/{ItemID} #

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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"
}
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

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

Updates one item's basic fields.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel.

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes Item identifier.
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.
DescriptionquerystringNo The `Description` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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 #

Updates one item's price breaks.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel.

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes Item identifier.
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

GET /v1/items/{itemID}/quote-readiness #

Parameters

NameInTypeRequiredDetailsDescription
itemIDpathstringYes The `itemID` route parameter. Required.

Responses

200 OK
PUT /v1/items/{itemID}/quote-readiness #

Parameters

NameInTypeRequiredDetailsDescription
itemIDpathstringYes The `itemID` route parameter. Required.

Responses

200 OK

Schemas: ItemQuoteReadinessModel

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

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes The `ItemID` route parameter. Required.

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 #

Updates one item's router.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel.

Parameters

NameInTypeRequiredDetailsDescription
ItemIDpathstringYes Item identifier.
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

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/attribute-definitions #

Parameters

NameInTypeRequiredDetailsDescription
includeInactivequerybooleanNo default: false The `includeInactive` query-string parameter. Optional; defaults to `False`.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/items/attribute-definitions/{id} #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

200 OK

Schemas: ItemAttributeDefinitionModel

GET /v1/items/attribute-definitions/{id}/impact #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.
targetIDquerystringNo The `targetID` query-string parameter. Optional; defaults to ``.

Responses

200 OK
POST /v1/items/attribute-definitions/{id}/merge #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

200 OK

Schemas: ItemAttributeMergeModel

GET /v1/items/attribute-definitions/proposals #

Responses

200 OK
403 Forbidden application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/attribute-definitions/quality #

Responses

200 OK
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 #

Updates a batch of items, processing valid records and rejecting governed records individually.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel containing record-level errors.

Parameters

NameInTypeRequiredDetailsDescription
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ItemModel ProblemDetails

PUT /v1/items/batch #

Creates a batch of items, processing valid records and rejecting governed records individually.

By default, the response is the legacy integer row count. Set `includeResults=true` to receive an Velosity.ImportExport.OperationResultModel containing record-level errors.

Parameters

NameInTypeRequiredDetailsDescription
includeResultsquerybooleanNo default: false Returns detailed operation results instead of the legacy row count.

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

NameInTypeRequiredDetailsDescription
NumberpathstringYes The `Number` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
whatquerystringNo The `what` query-string parameter. Optional; defaults to ``.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/items/graph/changes #

Parameters

NameInTypeRequiredDetailsDescription
afterqueryintegerNo format: int64 default: 0 The `after` query-string parameter. Optional; defaults to `0`.
limitqueryintegerNo format: int32 default: 250 The `limit` query-string parameter. Optional; defaults to `250`.

Responses

200 OK
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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.

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

POST /v1/items/quote-readiness/byids #

Responses

200 OK
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

NameInTypeRequiredDetailsDescription
qpathstringYes The `q` route parameter. Required.
limitqueryintegerNo format: int32 default: 2147483647 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

ItemStore

GET /v1/items/{itemID}/store #

Returns an Item's Store publication setting for administration.

Parameters

NameInTypeRequiredDetailsDescription
itemIDpathstringYes The `itemID` route parameter. Required.

Responses

200 OK application/json 
{
  "itemID": "example_001",
  "availableForStore": 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: ItemStoreAvailabilityModel ProblemDetails

PATCH /v1/items/{itemID}/store #

Publishes or removes an Item from the Store catalog.

Parameters

NameInTypeRequiredDetailsDescription
itemIDpathstringYes The `itemID` route parameter. Required.

Responses

200 OK application/json 
{
  "itemID": "example_001",
  "availableForStore": false
}
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: ItemStoreAvailabilityModel ProblemDetails UpdateItemStoreAvailabilityModel

GET /v1/items/store/catalog #

Returns Items explicitly published to the Store.

Responses

200 OK application/json 
"example"

Schemas: StoreItemCatalogModel

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

NameInTypeRequiredDetailsDescription
LocationIDpathstringYes The `LocationID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/locations/{LocationID} #

Parameters

NameInTypeRequiredDetailsDescription
LocationIDpathstringYes The `LocationID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/locations/{LocationID} #

Parameters

NameInTypeRequiredDetailsDescription
LocationIDpathstringYes The `LocationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
LocationIDpathstringYes The `LocationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
LocationIDpathstringYes The `LocationID` route parameter. Required.
ImportIDquerystringNo The `ImportID` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.
LogTypequerystringNo default: MESSAGES The `LogType` query-string parameter. Optional; defaults to `MESSAGES`.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
ImportIDpathstringYes The `ImportID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ImportIDquerystringNo The `ImportID` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.
DescriptionquerystringNo The `Description` query-string parameter.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PlanIDpathstringYes The `PlanID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
IsActivequerystringNo The `IsActive` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
IsActivequerystringNo The `IsActive` query-string parameter. Optional; defaults to ``.

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

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 25 The `Limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 25 The `Limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 25 The `Limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 25 The `Limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
StatusquerystringNo default: U enum: U, R The `Status` query-string parameter. Optional; defaults to `U`. Internal constants: `U`, `R`.

Responses

200 OK
GET /v1/notifications/{NotificationID} #

Parameters

NameInTypeRequiredDetailsDescription
NotificationIDpathstringYes The `NotificationID` route parameter. Required.

Responses

200 OK
GET /v1/notifications/{NotificationID}/dismiss #

Parameters

NameInTypeRequiredDetailsDescription
NotificationIDpathstringYes The `NotificationID` route parameter. Required.

Responses

200 OK
PATCH /v1/notifications/{NotificationID}/status #

Parameters

NameInTypeRequiredDetailsDescription
NotificationIDpathstringYes The `NotificationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RolepathstringYes The `Role` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/incoterms/{TermID} #

Parameters

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/incoterms/{TermID} #

Parameters

NameInTypeRequiredDetailsDescription
TermIDpathstringYes The `TermID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PackingListIDpathstringYes The `PackingListID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/packinglists/{PackingListID} #

Parameters

NameInTypeRequiredDetailsDescription
PackingListIDpathstringYes The `PackingListID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/packinglists/{PackingListID} #

Parameters

NameInTypeRequiredDetailsDescription
PackingListIDpathstringYes The `PackingListID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PackingListIDpathstringYes The `PackingListID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PageIDpathstringYes The `PageID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pages/{PageID} #

Parameters

NameInTypeRequiredDetailsDescription
PageIDpathstringYes The `PageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PageIDpathstringYes The `PageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PageIDpathstringYes The `PageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PageIDpathstringYes The `PageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/phases/{PhaseID} #

Parameters

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/phases/{PhaseID} #

Parameters

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ListIDpathstringYes The `ListID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pricelists/{ListID} #

Parameters

NameInTypeRequiredDetailsDescription
ListIDpathstringYes The `ListID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/pricelists/{ListID} #

Parameters

NameInTypeRequiredDetailsDescription
ListIDpathstringYes The `ListID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ListIDpathstringYes The `ListID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ListIDpathstringYes The `ListID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PricingComponentIDpathstringYes The `PricingComponentID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/pricingcomponents/{PricingComponentID} #

Parameters

NameInTypeRequiredDetailsDescription
PricingComponentIDpathstringYes The `PricingComponentID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/pricingcomponents/{PricingComponentID} #

Parameters

NameInTypeRequiredDetailsDescription
PricingComponentIDpathstringYes The `PricingComponentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PricingComponentIDpathstringYes The `PricingComponentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PricingComponentIDpathstringYes The `PricingComponentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.

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",
  "created": false
}
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

NameInTypeRequiredDetailsDescription
FamilyIDpathstringYes The `FamilyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
FamilyIDpathstringYes The `FamilyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
FamilyIDpathstringYes The `FamilyID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 3 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EscalationIDpathstringYes The `EscalationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EscalationIDpathstringYes The `EscalationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EscalationIDpathstringYes The `EscalationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CreatedByUserIDquerystringNo The `CreatedByUserID` query-string parameter.
StatusquerystringNo The `Status` query-string parameter.
CustomerIDquerystringNo The `CustomerID` query-string parameter.
CreatedUTCYearqueryintegerNo format: int32 The `CreatedUTCYear` query-string parameter.
CreatedUTCMonthqueryintegerNo format: int32 The `CreatedUTCMonth` query-string parameter.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ImageIDpathstringYes The `ImageID` route parameter. Required.
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/productionorderphases/{PhaseID} #

Parameters

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/productionorderphases/{PhaseID} #

Parameters

NameInTypeRequiredDetailsDescription
PhaseIDpathstringYes The `PhaseID` route parameter. Required.

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
GET /v1/prodorders/{ProductionOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
POST /v1/prodorders/{ProductionOrderID}/cancel #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderCancelModel

POST /v1/prodorders/{ProductionOrderID}/documents #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
DescriptionquerystringNo The `Description` query-string parameter.

Responses

200 OK
401 Unauthorized
DELETE /v1/prodorders/{ProductionOrderID}/documents/{DocumentID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

Responses

200 OK
401 Unauthorized
GET /v1/prodorders/{ProductionOrderID}/documents/{DocumentID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

Responses

200 OK
401 Unauthorized
POST /v1/prodorders/{ProductionOrderID}/documents/alpha #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized
PATCH /v1/prodorders/{ProductionOrderID}/history #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/lotnumbers #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/notes #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

GET /v1/prodorders/{ProductionOrderID}/pdf #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
DocumentIDquerystringNo The `DocumentID` query-string parameter. Optional; defaults to ``.

Responses

200 OK
401 Unauthorized
GET /v1/prodorders/{ProductionOrderID}/pdf/validate #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
DocumentIDquerystringNo The `DocumentID` query-string parameter.

Responses

200 OK
401 Unauthorized
PATCH /v1/prodorders/{ProductionOrderID}/phase #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/serialnumbers #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/tags #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

PATCH /v1/prodorders/{ProductionOrderID}/tasks #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
401 Unauthorized

Schemas: ProductionOrderModel

POST /v1/prodorders/{ProductionOrderID}/tasks/{ProductionOrderTaskID}/status #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ProductionOrderTaskIDpathstringYes The `ProductionOrderTaskID` route parameter. Required.

Responses

200 OK

Schemas: ProductionOrderTaskStatusUpdateRequest

GET /v1/prodorders/{ProductionOrderID}/tasks/{TaskID}/documents/{DocumentID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
TaskIDpathstringYes The `TaskID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

Responses

200 OK
401 Unauthorized
POST /v1/prodorders/assignments/reconcile #

Responses

200 OK
GET /v1/prodorders/bycustomers #

Parameters

NameInTypeRequiredDetailsDescription
statusqueryintegerNo format: int32 default: -10 The `status` query-string parameter. Optional; defaults to `-10`.

Responses

200 OK
GET /v1/prodorders/byphase/{phase} #

Parameters

NameInTypeRequiredDetailsDescription
phasepathstringYes The `phase` route parameter. Required.

Responses

200 OK
GET /v1/prodorders/bypriority/{priority} #

Parameters

NameInTypeRequiredDetailsDescription
PrioritypathstringYes The `Priority` route parameter. Required.
CountqueryintegerNo format: int32 The `Count` query-string parameter.

Responses

200 OK
GET /v1/prodorders/bysalesorder/{SalesOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

Responses

200 OK
GET /v1/prodorders/byserviceticketline/{serviceTicketLineItemID} #

Parameters

NameInTypeRequiredDetailsDescription
serviceTicketLineItemIDpathstringYes The `serviceTicketLineItemID` route parameter. Required.

Responses

200 OK
GET /v1/prodorders/bystatus/{Status} #

Parameters

NameInTypeRequiredDetailsDescription
StatuspathintegerYes format: int32 enum: -2, -1, 1, 10, 2, 3, 4 The `Status` route parameter. Required. Internal constants: `-2`, `-1`, `1`, `10`, `2`, `3`, `4`.
CountqueryintegerNo format: int32 The `Count` query-string parameter.

Responses

200 OK
GET /v1/prodorders/count #

Responses

200 OK
PATCH /v1/prodorders/createdby #

Responses

200 OK
401 Unauthorized

Schemas: UpdateCreatedByModel

GET /v1/prodorders/customers #

Responses

200 OK
GET /v1/prodorders/export #

Responses

200 OK
401 Unauthorized
POST /v1/prodorders/import #

Responses

200 OK
401 Unauthorized
GET /v1/prodorders/pages/{Page} #

Parameters

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

Responses

200 OK
POST /v1/prodorders/pages/{Page} #

Parameters

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

Responses

200 OK

Schemas: ProductionOrderSlicerModel

POST /v1/prodorders/pages/{Page}/customers #

Parameters

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

Responses

200 OK

Schemas: ProductionOrderSlicerModel

POST /v1/prodorders/pages/{Page}/salesorders #

Parameters

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

Responses

200 OK

Schemas: ProductionOrderSlicerModel

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

Parameters

NameInTypeRequiredDetailsDescription
qquerystringNo The `q` query-string parameter.
searchforpathstringYes The `searchfor` route parameter. Required.

Responses

200 OK
401 Unauthorized

ProductionOrdersBatch

GET /v1/prodorders/batches #

Responses

200 OK
DELETE /v1/prodorders/batches/{BatchID} #

Parameters

NameInTypeRequiredDetailsDescription
BatchIDpathstringYes The `BatchID` route parameter. Required.

Responses

200 OK
GET /v1/prodorders/batches/{BatchID} #

Parameters

NameInTypeRequiredDetailsDescription
BatchIDpathstringYes The `BatchID` route parameter. Required.

Responses

200 OK
PATCH /v1/prodorders/batches/{BatchID} #

Parameters

NameInTypeRequiredDetailsDescription
BatchIDpathstringYes The `BatchID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
downloadquerybooleanNo default: false The `download` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ProductionOrderTaskIDpathstringYes The `ProductionOrderTaskID` route parameter. Required.

Responses

200 OK
POST /v1/prodorders/{ProductionOrderID}/Tasks/{ProductionOrderTaskID}/clockout #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.
ProductionOrderTaskIDpathstringYes The `ProductionOrderTaskID` route parameter. Required.

Responses

200 OK
GET /v1/prodorders/events #

Parameters

NameInTypeRequiredDetailsDescription
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

POST /v1/prodorders/events #

Parameters

NameInTypeRequiredDetailsDescription
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductionEventsSlicerModel

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
UserIDpathstringYes The `UserID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskNamepathstringYes The `TaskName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskNamepathstringYes The `TaskName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskNamepathstringYes The `TaskName` route parameter. Required.
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
EventIDpathstringYes The `EventID` route parameter. Required.

Responses

200 OK

Products

GET /v1/products #

Parameters

NameInTypeRequiredDetailsDescription
IsActivequerystringNo default: ANY The `IsActive` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/products/{ProductID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
namequerystringNo The `name` query-string parameter.
revisionquerystringNo The `revision` query-string parameter.
descriptionquerystringNo The `description` query-string parameter.
visibilityquerystringNo The `visibility` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

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

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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}/image #

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProductModel

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

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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}/images #

Parameters

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
numberpathstringYes The `number` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SnapshotIDpathstringYes The `SnapshotID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
SnapshotIDpathstringYes The `SnapshotID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.

Responses

200 OK
PUT /v1/products/{productID}/take-rate-analyses #

Parameters

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.

Responses

200 OK

Schemas: ProductTakeRateAnalysisModel

DELETE /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.
analysisIDpathstringYes The `analysisID` route parameter. Required.

Responses

200 OK
GET /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.
analysisIDpathstringYes The `analysisID` route parameter. Required.

Responses

200 OK
PATCH /v1/products/{productID}/take-rate-analyses/{analysisID} #

Parameters

NameInTypeRequiredDetailsDescription
productIDpathstringYes The `productID` route parameter. Required.
analysisIDpathstringYes The `analysisID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PromotionIDpathstringYes The `PromotionID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/promotions/{PromotionID} #

Parameters

NameInTypeRequiredDetailsDescription
PromotionIDpathstringYes The `PromotionID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/promotions/{PromotionID} #

Parameters

NameInTypeRequiredDetailsDescription
PromotionIDpathstringYes The `PromotionID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PromotionIDpathstringYes The `PromotionID` route parameter. Required.
SalesQuoteIDquerystringNo The `SalesQuoteID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

204 No Content
PUT /v1/purchasing/rules/{id} #

Updates an existing purchasing watch rule.

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AssetIDpathstringYes The `AssetID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AssetIDpathstringYes The `AssetID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AssetIDpathstringYes The `AssetID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AssetIDpathstringYes The `AssetID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

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

NameInTypeRequiredDetailsDescription
searchpathstringYes The `search` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
AuditIDpathstringYes The `AuditID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityCapaIDpathstringYes The `QualityCapaID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityCapaIDpathstringYes The `QualityCapaID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityCapaIDpathstringYes The `QualityCapaID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityCapaIDpathstringYes The `QualityCapaID` route parameter. Required.
PhasepathstringYes The `Phase` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ChangeIDpathstringYes The `ChangeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ChangeIDpathstringYes The `ChangeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ChangeIDpathstringYes The `ChangeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ChangeIDpathstringYes The `ChangeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
recordcountqueryintegerNo format: int32 default: 25 The `recordcount` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
QualityNcrIDpathstringYes The `QualityNcrID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityNcrIDpathstringYes The `QualityNcrID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityNcrIDpathstringYes The `QualityNcrID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityNcrIDpathstringYes The `QualityNcrID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
QualityNcrIDpathstringYes The `QualityNcrID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
searchpathstringYes The `search` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
statuspathstringYes default: OPEN The `status` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
datepathstringYes The `date` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportpathstringYes The `Report` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceGroupIDpathstringYes The `ResourceGroupID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/resourcegroups/{ResourceGroupID} #

Parameters

NameInTypeRequiredDetailsDescription
ResourceGroupIDpathstringYes The `ResourceGroupID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/resourcegroups/{ResourceGroupID} #

Parameters

NameInTypeRequiredDetailsDescription
ResourceGroupIDpathstringYes The `ResourceGroupID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceGroupIDpathstringYes The `ResourceGroupID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceGroupNamepathstringYes The `ResourceGroupName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/resources/{ResourceID} #

Parameters

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/resources/{ResourceID} #

Parameters

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ResourceNamepathstringYes The `ResourceName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/rules/{RuleID} #

Parameters

NameInTypeRequiredDetailsDescription
RuleIDpathstringYes The `RuleID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/rules/{RuleID} #

Parameters

NameInTypeRequiredDetailsDescription
RuleIDpathstringYes The `RuleID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/rules/{RuleID} #

Parameters

NameInTypeRequiredDetailsDescription
RuleIDpathstringYes The `RuleID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
RuleGroupIDpathstringYes The `RuleGroupID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
numberpathstringYes The `number` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 2147483647 Maximum number of records to return. Defaults to `int.MaxValue`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: SalesOrderModel

POST /v1/salesorders #

Retrieves sales orders using the provided slicer model.

Parameters

NameInTypeRequiredDetailsDescription
LimitqueryintegerNo format: int32 default: 2147483647 Optional maximum number of records to return. Defaults to `int.MaxValue`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: SalesOrderModel SalesOrderSlicerModel

PUT /v1/salesorders #

Creates a new Sales Order.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID} #

Deletes the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order to delete.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found
GET /v1/salesorders/{SalesOrderID} #

Retrieves a single Sales Order by its unique identifier.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order to retrieve. This value is required and must match an existing Sales Order.
updateattributesquerybooleanNo 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
401 Unauthorized
500 Internal Server Error
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"
}
404 Not Found

Schemas: SalesOrderModel

PATCH /v1/salesorders/{SalesOrderID}/basics #

Updates the basic fields of the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order to update.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

PUT /v1/salesorders/{SalesOrderID}/changeorders #

Adds a change order entry to the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: ChangeOrderModel

PATCH /v1/salesorders/{SalesOrderID}/customer #

Updates the customer information for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose customer information should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

POST /v1/salesorders/{SalesOrderID}/documents #

Uploads a document for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: DocumentUploadModel

DELETE /v1/salesorders/{SalesOrderID}/documents/{DocumentID} #

Deletes a document from the specified Sales Order and removes the associated file(s).

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.
DocumentIDpathstringYes The unique identifier of the document to delete.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found
GET /v1/salesorders/{SalesOrderID}/documents/{DocumentID} #

Retrieves a stored document for the specified Sales Order and streams it to the client.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.
DocumentIDpathstringYes The unique identifier of the document.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found
POST /v1/salesorders/{SalesOrderID}/email #

Sends a Sales Order as a PDF email to a specified person.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order to email.
PersonIDquerystringNo The unique identifier of the recipient person.
FormatquerystringNo default: pdf enum: pdf The output format (default: "pdf"). Supported values: `pdf`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: EmailMessageModel

GET /v1/salesorders/{SalesOrderID}/finishdate #

Retrieves the latest (maximum) planned completion date for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose finish date should be retrieved. This value is required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"2026-01-15T12:00:00Z"
404 Not Found
PATCH /v1/salesorders/{SalesOrderID}/history #

Updates the history entries for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose history should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

PATCH /v1/salesorders/{SalesOrderID}/items #

Updates the item collection for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose items should be updated.
requiredStatusquerystringNo Optional status that must still match when the database write occurs.
requireUnchangedquerybooleanNo default: false When true, requires the stored last-update timestamp to match the submitted document.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID}/items/{itemandqtyid} #

Deletes a specific item from the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.
itemandqtyidpathstringYes The unique identifier of the item to delete.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found
PATCH /v1/salesorders/{SalesOrderID}/lineitems #

Updates the line items for the specified Sales Order and synchronizes related Production Orders.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose line items should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

DELETE /v1/salesorders/{SalesOrderID}/lineitems/{lineitemid} #

Deletes a specific line item from the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.
lineitemidpathstringYes The unique identifier of the line item to delete.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found
GET /v1/salesorders/{SalesOrderID}/lineitems/{LineItemID}/prodorders #

Retrieves the Production Orders associated with the specified Sales Order and Line Item.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.
LineItemIDpathstringYes The unique identifier of the Line Item.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose notes should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

PUT /v1/salesorders/{SalesOrderID}/notes #

Adds a note to the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: NoteModel

GET /v1/salesorders/{SalesOrderID}/pdf #

Generates a PDF for the specified Sales Order using the provided template.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order to render as a PDF.
DocumentIDquerystringNo Optional template DocumentID. If omitted or invalid, the default Sales Order template is used.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK application/pdf 
"example"
404 Not Found
GET /v1/salesorders/{SalesOrderID}/public/url #

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK
PATCH /v1/salesorders/{SalesOrderID}/status #

Updates the status of the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose status should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderStatusUpdateModel

POST /v1/salesorders/{SalesOrderID}/statuscheck #

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
PATCH /v1/salesorders/{SalesOrderID}/tags #

Updates the tag collection for the specified Sales Order.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The unique identifier of the Sales Order whose tags should be updated.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
404 Not Found

Schemas: SalesOrderModel

GET /v1/salesorders/analysis/configurations #

Retrieves configuration analysis results for the specified Product ID.

Parameters

NameInTypeRequiredDetailsDescription
ProductIDquerystringNo The unique identifier of the product whose configuration analysis should be retrieved.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: ConfigurationAnalysisMonthModel

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

Retrieves all Sales Orders associated with the specified Customer ID.

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The unique identifier of the customer whose Sales Orders should be retrieved. This value is required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found

Schemas: SalesOrderModel

POST /v1/salesorders/byids #

Retrieves multiple Sales Orders by their unique identifiers.

Parameters

NameInTypeRequiredDetailsDescription
updateattributesquerybooleanNo default: false Optional. Indicates whether attribute hydration should be performed for each returned Sales Order. Defaults to `false`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found

Schemas: SalesOrderModel

GET /v1/salesorders/byquoteid/{SalesQuoteID} #

Retrieves the Sales Order associated with the specified Sales Quote ID.

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The unique identifier of the Sales Quote whose Sales Order should be retrieved. This value is required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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"
}
404 Not Found

Schemas: SalesOrderModel

POST /v1/salesorders/count #

Retrieves the count of Sales Orders matching the provided slicer criteria.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0

Schemas: SalesOrderSlicerModel

PATCH /v1/salesorders/createdby #

Updates the "Created By" user information for one or more Sales Orders.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0

Schemas: UpdateCreatedByModel

GET /v1/salesorders/createdby/{UserID} #

Retrieves all Sales Orders created by the specified user.

Parameters

NameInTypeRequiredDetailsDescription
UserIDpathstringYes The unique identifier of the user whose created Sales Orders should be retrieved. This value is required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found

Schemas: SalesOrderModel

GET /v1/salesorders/customers #

Retrieves all customers that have associated Sales Orders.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
GET /v1/salesorders/export/lineitems #

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
POST /v1/salesorders/export/lineitems #

Exports all Sales Order line items as a CSV file.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: SalesOrderSlicerModel

GET /v1/salesorders/export/profitability #

Parameters

NameInTypeRequiredDetailsDescription
fromquerystringNo format: date-time The `from` query-string parameter.
toquerystringNo format: date-time The `to` query-string parameter.
bundlequerybooleanNo default: false The `bundle` query-string parameter. Optional; defaults to `False`.
downloadquerybooleanNo default: false The `download` query-string parameter. Optional; defaults to `False`.
includeLogquerybooleanNo default: false The `includeLog` query-string parameter. Optional; defaults to `False`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
fileNamepathstringYes The `fileName` route parameter. Required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found
POST /v1/salesorders/export/profitability/jobs #

Parameters

NameInTypeRequiredDetailsDescription
fromquerystringNo format: date-time The `from` query-string parameter.
toquerystringNo format: date-time The `to` query-string parameter.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
202 Accepted
503 Service Unavailable
GET /v1/salesorders/export/profitability/jobs/{jobID} #

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
GET /v1/salesorders/export/profitability/jobs/{jobID}/{file} #

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.
filepathstringYes The `file` route parameter. Required.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
GET /v1/salesorders/export/summary #

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
POST /v1/salesorders/export/summary #

Exports a summary of Sales Orders as a CSV file.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: SalesOrderSlicerModel

GET /v1/salesorders/export/xml #

Exports the specified XML template used for Sales Order processing.

Parameters

NameInTypeRequiredDetailsDescription
TemplateIDquerystringNo The unique identifier of the XML template.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found
POST /v1/salesorders/finishdates #

Retrieves the finish dates for the specified list of Sales Order IDs.

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDsqueryarray of stringNo 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
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found

Schemas: SalesOrderFinishDateModel

POST /v1/salesorders/import #

Imports Sales Orders from an uploaded file.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
{
  "importID": "example_001",
  "messages": "example",
  "errors": "example",
  "status": "example",
  "operationType": "example",
  "linesProcessed": 0,
  "fileName": "Example name",
  "timeRequired": 0
}

Schemas: ImportResultModel

GET /v1/salesorders/import/results #

Retrieves the most recent import results for Sales Orders.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
{
  "importID": "example_001",
  "messages": "example",
  "errors": "example",
  "status": "example",
  "operationType": "example",
  "linesProcessed": 0,
  "fileName": "Example name",
  "timeRequired": 0
}

Schemas: ImportResultModel

GET /v1/salesorders/mtd #

Retrieves all Sales Orders created or updated Month‑To‑Date (MTD).

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 The page number to retrieve. Must be `>= 1`.
RecordsPerPagequeryintegerNo format: int32 The number of records per page. Must be `>= 1`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"

Schemas: SalesOrderModel SalesOrderSlicerModel

GET /v1/salesorders/public/validate #

Validates a public Sales Order key.

Parameters

NameInTypeRequiredDetailsDescription
keyquerystringNo The public key to validate.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
ordernumberpathstringYes The order number or partial order number to search for.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
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
401 Unauthorized
500 Internal Server Error
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
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
StatuspathstringYes enum: DRAFT, RESERVED, ONHOLD, RELEASED, CANCELLED, FINISHED, COMPLETED, SHIPPEDPARTIAL, SHIPPED The current Sales Order status. Must be a valid status value defined in Velosity.Sales.SalesOrderModel. Internal constants: `DRAFT`, `RESERVED`, `ONHOLD`, `RELEASED`, `CANCELLED`, `FINISHED`, `COMPLETED`, `SHIPPEDPARTIAL`, `SHIPPED`.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
"example"
404 Not Found
GET /v1/salesorders/status/check #

Triggers an asynchronous Sales Order status check operation.

Responses

400 Bad Request
401 Unauthorized
500 Internal Server Error
200 OK text/plain 
0
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
401 Unauthorized
500 Internal Server Error
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
401 Unauthorized
500 Internal Server Error
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

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesfunnel/{OpportunityID} #

Parameters

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/salesfunnel/{OpportunityID} #

Parameters

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

Responses

200 OK

Schemas: EmailMessageModel

PATCH /v1/salesfunnel/{OpportunityID}/tags #

Parameters

NameInTypeRequiredDetailsDescription
OpportunityIDpathstringYes The `OpportunityID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
StatusquerySalesOpportunityStatusNo The `Status` query-string parameter.

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

NameInTypeRequiredDetailsDescription
StatusquerySalesOpportunityStatusNo The `Status` query-string parameter.
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PUT /v1/salesfunnel/sendtouser #

Parameters

NameInTypeRequiredDetailsDescription
OpportunityIDquerystringNo The `OpportunityID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
salesOrderIDpathstringYes The `salesOrderID` route parameter. Required.

Responses

200 OK
POST /v1/salesorders/{salesOrderID}/analysis/production-comparison/generate #

Parameters

NameInTypeRequiredDetailsDescription
salesOrderIDpathstringYes The `salesOrderID` route parameter. Required.

Responses

200 OK
DELETE /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

200 OK
GET /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

200 OK
PATCH /v1/salesorders/analysis/production-comparisons/{id} #

Parameters

NameInTypeRequiredDetailsDescription
idpathstringYes The `id` route parameter. Required.

Responses

200 OK

Schemas: SalesOrderProductionComparisonModel

POST /v1/salesorders/analysis/production-comparisons/generate-all #

Responses

200 OK
GET /v1/salesorders/analysis/production-comparisons/generate-all/{jobID} #

Parameters

NameInTypeRequiredDetailsDescription
jobIDpathstringYes The `jobID` route parameter. Required.

Responses

200 OK

SalesQuoteEmailLog

GET /v1/salesquotes/logs/email #

Parameters

NameInTypeRequiredDetailsDescription
countqueryintegerNo format: int32 default: 50 The `count` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
LogIDpathstringYes The `LogID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

SalesQuoteMarginApprovals

POST /v1/process-events #

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"
}
409 Conflict application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ProcessEventModel

GET /v1/salesquotes/{salesQuoteId}/commercial-terms #

Parameters

NameInTypeRequiredDetailsDescription
salesQuoteIdpathstringYes The `salesQuoteId` route parameter. Required.

Responses

200 OK application/json 
"example"

Schemas: SalesQuoteLineCommercialTermsModel

PUT /v1/salesquotes/{salesQuoteId}/lines/{lineId}/commercial-terms #

Parameters

NameInTypeRequiredDetailsDescription
salesQuoteIdpathstringYes The `salesQuoteId` route parameter. Required.
lineIdpathstringYes The `lineId` route parameter. Required.

Responses

200 OK

Schemas: SalesQuoteLineCommercialTermsModel

GET /v1/salesquotes/{salesQuoteId}/margin-approvals #

Parameters

NameInTypeRequiredDetailsDescription
salesQuoteIdpathstringYes The `salesQuoteId` route parameter. Required.

Responses

200 OK application/json 
"example"
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteMarginApprovalModel

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID} #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
DeliveryOptionIDpathstringYes The `DeliveryOptionID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
DocumentIDpathstringYes The `DocumentID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
PersonIDquerystringNo The `PersonID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
requiredStatusquerystringNo The `requiredStatus` query-string parameter.
requireUnchangedquerybooleanNo default: false The `requireUnchanged` query-string parameter. Optional; defaults to `False`.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
itemandqtyidpathstringYes The `itemandqtyid` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/salesquotes/{SalesQuoteID}/items/{ItemID}/pricing #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
ItemIDpathstringYes The `ItemID` route parameter. Required.

Responses

200 OK application/json 
{
  "costSource": "example",
  "unitCost": 0,
  "policyID": "example_001",
  "policyVersion": "example",
  "policySource": "example",
  "targetMarginPercent": 0,
  "unitPrice": 0,
  "currencyID": "example_001"
}
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: GovernedItemPricingModel ProblemDetails

PATCH /v1/salesquotes/{SalesQuoteID}/lineitems #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
lineitemidpathstringYes The `lineitemid` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
LineItemIDpathstringYes The `LineItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
LineItemIDpathstringYes The `LineItemID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
keyquerystringNo The `key` query-string parameter.

Responses

200 OK application/json 
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"
}
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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK
POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK

Schemas: PurchaseOrderPaymentUploadModel

POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/approve #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK application/json 
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"
}
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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK
POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/reject #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK application/json 
0
POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/upload #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
keyquerystringNo The `key` query-string parameter.

Responses

200 OK

Schemas: PurchaseOrderPaymentUploadModel

POST /v1/salesquotes/{SalesQuoteID}/payment/test/{Outcome} #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
OutcomepathstringYes The `Outcome` route parameter. Required.

Responses

200 OK application/json 
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"
}
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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
DocumentIDquerystringNo The `DocumentID` query-string parameter.
PreviewquerystringNo The `Preview` query-string parameter.
keyquerystringNo The `key` query-string parameter.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
DocumentIDquerystringNo The `DocumentID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SalesQuoteUpdateValidityModel

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/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

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
UserIDpathstringYes The `UserID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
keyquerystringNo The `key` query-string parameter.

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

NameInTypeRequiredDetailsDescription
keyquerystringNo The `key` query-string parameter.

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

NameInTypeRequiredDetailsDescription
limitqueryintegerNo format: int32 default: 5 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
quotenumberpathstringYes The `quotenumber` route parameter. Required.

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.

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

200 OK application/json 
{
  "mermaid": "example_001"
}
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}
500 Internal Server Error

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/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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
SimulationIDpathstringYes The `SimulationID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
SimulationIDpathstringYes The `SimulationID` route parameter. Required.

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
GET /v1/schedule/assigned/{ResourceID} #

Parameters

NameInTypeRequiredDetailsDescription
ResourceIDpathstringYes The `ResourceID` route parameter. Required.

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
GET /v1/schedule/customers #

Responses

200 OK
GET /v1/schedule/customers/{CustomerID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
StatusquerystringNo enum: REQUIRED, DELIVERED The `Status` query-string parameter. Internal constants: `REQUIRED`, `DELIVERED`.

Responses

200 OK
GET /v1/schedule/materials/{RequestID} #

Parameters

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

Responses

200 OK
PATCH /v1/schedule/materials/{RequestID} #

Parameters

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

Responses

200 OK

Schemas: ProductionOrderMaterialsUpdateModel

GET /v1/schedule/materials/{RequestID}/movements #

Parameters

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

Responses

200 OK
GET /v1/schedule/materials/days/{Days} #

Parameters

NameInTypeRequiredDetailsDescription
StatusquerystringNo enum: REQUIRED, DELIVERED The `Status` query-string parameter. Internal constants: `REQUIRED`, `DELIVERED`.
DayspathintegerYes format: int32 default: 0 The `Days` route parameter. Required.

Responses

200 OK
GET /v1/schedule/materials/production-orders/{ProductionOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
GET /v1/schedule/month #

Parameters

NameInTypeRequiredDetailsDescription
ViewByquerystringNo The `ViewBy` query-string parameter.
YearqueryintegerNo format: int32 The `Year` query-string parameter.
MonthNumqueryintegerNo format: int32 The `MonthNum` query-string parameter.

Responses

200 OK
POST /v1/schedule/pages/{page} #

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.

Responses

200 OK

Schemas: ScheduleSlicerModel

POST /v1/schedule/queues/export #

Parameters

NameInTypeRequiredDetailsDescription
FormatquerystringNo default: csv enum: csv The `Format` query-string parameter. Optional; defaults to `csv`. Supported values: `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

NameInTypeRequiredDetailsDescription
searchforpathstringYes The `searchfor` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
FormatquerystringNo default: csv enum: csv The `Format` query-string parameter. Optional; defaults to `csv`. Supported values: `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

NameInTypeRequiredDetailsDescription
QueueNamepathstringYes The `QueueName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
PagepathintegerYes format: int32 default: 1 The `Page` route parameter. Required. Pages are 1-based.

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/tasks/queues #

Parameters

NameInTypeRequiredDetailsDescription
LocationIDquerystringNo The `LocationID` query-string parameter.

Responses

200 OK
GET /v1/schedule/tasks/queues/{QueueName} #

Parameters

NameInTypeRequiredDetailsDescription
QueueNamepathstringYes The `QueueName` route parameter. Required.

Responses

200 OK
GET /v1/schedule/users/assigned #

Responses

200 OK

ScheduleResequenceRequests

GET /v1/prodorders/{ProductionOrderID}/resequence/request #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
RequestIDpathstringYes The `RequestID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails ScheduleResequenceRequestSlicerModel

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
DELETE /v1/serialization/{SerialID} #

Parameters

NameInTypeRequiredDetailsDescription
SerialIDpathstringYes The `SerialID` route parameter. Required.

Responses

200 OK
GET /v1/serialization/{SerialID} #

Parameters

NameInTypeRequiredDetailsDescription
SerialIDpathstringYes The `SerialID` route parameter. Required.

Responses

200 OK
PATCH /v1/serialization/{SerialID} #

Parameters

NameInTypeRequiredDetailsDescription
SerialIDpathstringYes The `SerialID` route parameter. Required.

Responses

200 OK

Schemas: SerializationSerialNumberModel

PATCH /v1/serialization/{SerialID}/batch #

Parameters

NameInTypeRequiredDetailsDescription
SerialIDpathstringYes The `SerialID` route parameter. Required.

Responses

200 OK

Schemas: SerializationSerialNumberModel

GET /v1/serialization/count #

Parameters

NameInTypeRequiredDetailsDescription
StatusquerystringNo enum: Valid, Expired, PENDING The `Status` query-string parameter. Internal constants: `Valid`, `Expired`, `PENDING`.

Responses

200 OK
GET /v1/serialization/customers/{CustomerID} #

Parameters

NameInTypeRequiredDetailsDescription
CustomerIDpathstringYes The `CustomerID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
StatusquerystringNo enum: Valid, Expired, PENDING The `Status` query-string parameter. Internal constants: `Valid`, `Expired`, `PENDING`.
limitqueryintegerNo format: int32 The `limit` query-string parameter.

Responses

200 OK
GET /v1/serialization/search/{SearchString} #

Parameters

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CodeIDpathstringYes The `CodeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CodeIDpathstringYes The `CodeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CodeIDpathstringYes The `CodeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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
DELETE /v1/service/tickets/{TicketID} #

Parameters

NameInTypeRequiredDetailsDescription
TicketIDpathstringYes The `TicketID` route parameter. Required.

Responses

200 OK
GET /v1/service/tickets/{TicketID} #

Parameters

NameInTypeRequiredDetailsDescription
TicketIDpathstringYes The `TicketID` route parameter. Required.

Responses

200 OK
PATCH /v1/service/tickets/{TicketID} #

Parameters

NameInTypeRequiredDetailsDescription
TicketIDpathstringYes The `TicketID` route parameter. Required.

Responses

200 OK

Schemas: ServiceTicketModel

GET /v1/service/tickets/by/salesorderid/{SalesOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.

Responses

200 OK
GET /v1/service/tickets/by/salesquoteid/{SalesQuoteID} #

Parameters

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
limitqueryintegerNo format: int32 default: 25 The `limit` query-string parameter. Optional; defaults to `25`.

Responses

200 OK
POST /v1/service/tickets/pages/{page} #

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
limitqueryintegerNo format: int32 default: 25 The `limit` query-string parameter. Optional; defaults to `25`.

Responses

200 OK

Schemas: ServiceTicketSlicerModel

GET /v1/service/tickets/search/{q} #

Parameters

NameInTypeRequiredDetailsDescription
qpathstringYes The `q` route parameter. Required.
limitqueryintegerNo format: int32 default: 2147483647 The `limit` query-string parameter. Optional; defaults to `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

NameInTypeRequiredDetailsDescription
jobIdpathstringYes The `jobId` route parameter. Required.

Responses

200 OK

SmartQuoteVersions

GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions #

Parameters

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
ProductIDpathstringYes The `ProductID` route parameter. Required.
VersionIDpathstringYes The `VersionID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
ProductIDpathstringYes The `ProductID` route parameter. Required.
VersionIDpathstringYes The `VersionID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
InstanceIDpathstringYes The `InstanceID` route parameter. Required.
ProductIDpathstringYes The `ProductID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
CountryIDpathstringYes The `CountryID` route parameter. Required.

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

StoreCatalog

GET /v1/configure/store/customers #

Parameters

NameInTypeRequiredDetailsDescription
customerIdquerystringNo The `customerId` query-string parameter.
emailquerystringNo The `email` query-string parameter.
domainOnlyquerybooleanNo default: false The `domainOnly` query-string parameter. Optional; defaults to `False`.

Responses

200 OK text/plain 
"example"

Schemas: CustomerModel

POST /v1/configure/store/customers #

Responses

200 OK text/plain 
{
  "customerID": "example_001",
  "number": "example",
  "customerNumber": "example",
  "name": "Example name",
  "customerName": "Example name",
  "address": "example",
  "city": "example",
  "state": "example"
}

Schemas: CustomerModel StoreCustomerCreate

GET /v1/configure/store/orders #

Parameters

NameInTypeRequiredDetailsDescription
customerIdquerystringNo The `customerId` query-string parameter.

Responses

200 OK text/plain 
"example"

Schemas: SalesOrderModel

GET /v1/configure/store/products #

Parameters

NameInTypeRequiredDetailsDescription
productIdquerystringNo The `productId` query-string parameter.
customerIdquerystringNo The `customerId` query-string parameter.
qquerystringNo The `q` query-string parameter.
limitqueryintegerNo format: int32 default: 200 The `limit` query-string parameter. Optional; defaults to `200`.

Responses

200 OK text/plain 
"example"

Schemas: StoreCatalogProductModel

GET /v1/configure/store/users #

Parameters

NameInTypeRequiredDetailsDescription
userIdquerystringNo The `userId` query-string parameter.

Responses

200 OK text/plain 
"example"

Schemas: UserModel

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

NameInTypeRequiredDetailsDescription
SupplierIDpathstringYes The `SupplierID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SupplierIDpathstringYes The `SupplierID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SupplierIDpathstringYes The `SupplierID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

PATCH /v1/suppliers/{SupplierID}/notes #

Parameters

NameInTypeRequiredDetailsDescription
SupplierIDpathstringYes The `SupplierID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
SupplierIDpathstringYes The `SupplierID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails SupplierModel

GET /v1/suppliers/ByNumber/{SupplierNumber} #

Get by SupplierNumber

Parameters

NameInTypeRequiredDetailsDescription
SupplierNumberpathstringYes The `SupplierNumber` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.

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

NameInTypeRequiredDetailsDescription
SearchStringpathstringYes The `SearchString` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

GET /v1/tasks/{TaskID} #

Parameters

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/tasks/{TaskID} #

Parameters

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskIDpathstringYes The `TaskID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TaskNamepathstringYes The `TaskName` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TargetInstanceIDpathstringYes The `TargetInstanceID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
numberpathstringYes The `number` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TeamIDpathstringYes The `TeamID` route parameter. Required.

Responses

200 OK
GET /v1/teams/{TeamID} #

Parameters

NameInTypeRequiredDetailsDescription
TeamIDpathstringYes The `TeamID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TeamIDpathstringYes The `TeamID` route parameter. Required.

Responses

200 OK

Schemas: TeamModel

POST /v1/teams/{TeamID}/members #

Parameters

NameInTypeRequiredDetailsDescription
TeamIDpathstringYes The `TeamID` route parameter. Required.

Responses

200 OK

Schemas: TeamMemberModel

DELETE /v1/teams/{TeamID}/members/{UserID} #

Parameters

NameInTypeRequiredDetailsDescription
TeamIDpathstringYes The `TeamID` route parameter. Required.
UserIDpathstringYes The `UserID` route parameter. Required.

Responses

200 OK
GET /v1/teams/my #

Responses

200 OK text/plain 
"example"

Schemas: TeamModel

TenantExports

POST /v1/internal/tenants/{tenantID}/exports #

Parameters

NameInTypeRequiredDetailsDescription
tenantIDpathstringYes The `tenantID` route parameter. Required.

Responses

200 OK

Schemas: TenantFullExportRequest

TenantNotes

GET /v1/tenants/{tenantId}/notes #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
includeDeletedquerybooleanNo default: false The `includeDeleted` query-string parameter. Optional; defaults to `False`.

Responses

200 OK application/json 
"example"
400 Bad Request application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TenantNoteModel

POST /v1/tenants/{tenantId}/notes #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.

Responses

201 Created application/json 
{
  "tenantNoteID": "example_001",
  "instanceID": "example_001",
  "category": "example",
  "status": "example",
  "summary": "example",
  "detail": "example",
  "sourceReference": "example",
  "metadataJSON": "example"
}
400 Bad Request application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails TenantNoteCreateModel TenantNoteModel

DELETE /v1/tenants/{tenantId}/notes/{noteId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
noteIdpathstringYes The `noteId` route parameter. Required.

Responses

204 No Content
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/tenants/{tenantId}/notes/{noteId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
noteIdpathstringYes The `noteId` route parameter. Required.

Responses

200 OK application/json 
{
  "tenantNoteID": "example_001",
  "instanceID": "example_001",
  "category": "example",
  "status": "example",
  "summary": "example",
  "detail": "example",
  "sourceReference": "example",
  "metadataJSON": "example"
}
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 TenantNoteModel

PUT /v1/tenants/{tenantId}/notes/{noteId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
noteIdpathstringYes The `noteId` route parameter. Required.

Responses

200 OK application/json 
{
  "tenantNoteID": "example_001",
  "instanceID": "example_001",
  "category": "example",
  "status": "example",
  "summary": "example",
  "detail": "example",
  "sourceReference": "example",
  "metadataJSON": "example"
}
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 TenantNoteModel TenantNoteUpdateModel

TenantProvisioning

POST /v1/provisioning/tenants #

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"
}
500 Internal Server Error

Schemas: ProblemDetails TenantProvisioningRequest TenantProvisioningResponse

GET /v1/provisioning/tenants/{tenantId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.

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/provisioning/tenants/{tenantId}/seed-runs #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.

Responses

200 OK application/json 
{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "seedProfileVersion": "example",
  "seedProfileHash": "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/provisioning/tenants/{tenantId}/seed-runs/{runId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
runIdpathstringYes The `runId` route parameter. Required.

Responses

200 OK application/json 
{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "seedProfileVersion": "example",
  "seedProfileHash": "example",
  "status": "example",
  "error": "example"
}

Schemas: TenantSeedRunStatusModel

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"
}
500 Internal Server Error

Schemas: ProblemDetails TenantProvisioningRequest TenantProvisioningResponse

GET /v1/tenant-provisioning/{tenantId} #

Parameters

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.

Responses

200 OK application/json 
{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "seedProfileVersion": "example",
  "seedProfileHash": "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

NameInTypeRequiredDetailsDescription
tenantIdpathstringYes The `tenantId` route parameter. Required.
runIdpathstringYes The `runId` route parameter. Required.

Responses

200 OK application/json 
{
  "runID": "example_001",
  "tenantID": "example_001",
  "seedProfile": "example",
  "seedProfileVersion": "example",
  "seedProfileHash": "example",
  "status": "example",
  "error": "example"
}

Schemas: TenantSeedRunStatusModel

TenantSeedProfiles

GET /v1/provisioning/profiles #

Responses

200 OK application/json 
"example"

Schemas: TenantSeedProfileModel

POST /v1/provisioning/profiles #

Responses

200 OK application/json 
{
  "profileID": "example_001",
  "displayName": "Example name",
  "version": "example",
  "status": "example",
  "manifestJson": "example",
  "manifestHash": "example",
  "createdByUserID": "example_001",
  "lastUpdatedByUserID": "example_001"
}

Schemas: TenantSeedProfileVersionModel TenantSeedProfileVersionWriteModel

GET /v1/provisioning/profiles/{profileId}/versions #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.

Responses

200 OK application/json 
"example"

Schemas: TenantSeedProfileVersionModel

GET /v1/provisioning/profiles/{profileId}/versions/{version} #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK application/json 
{
  "profileID": "example_001",
  "displayName": "Example name",
  "version": "example",
  "status": "example",
  "manifestJson": "example",
  "manifestHash": "example",
  "createdByUserID": "example_001",
  "lastUpdatedByUserID": "example_001"
}

Schemas: TenantSeedProfileVersionModel

PUT /v1/provisioning/profiles/{profileId}/versions/{version} #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK

Schemas: TenantSeedProfileVersionWriteModel

POST /v1/provisioning/profiles/{profileId}/versions/{version}/publish #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK
POST /v1/provisioning/profiles/{profileId}/versions/{version}/retire #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK
POST /v1/provisioning/profiles/{profileId}/versions/{version}/validate #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK
GET /v1/tenant-seed-profiles #

Responses

200 OK application/json 
"example"

Schemas: TenantSeedProfileModel

POST /v1/tenant-seed-profiles #

Responses

200 OK application/json 
{
  "profileID": "example_001",
  "displayName": "Example name",
  "version": "example",
  "status": "example",
  "manifestJson": "example",
  "manifestHash": "example",
  "createdByUserID": "example_001",
  "lastUpdatedByUserID": "example_001"
}

Schemas: TenantSeedProfileVersionModel TenantSeedProfileVersionWriteModel

GET /v1/tenant-seed-profiles/{profileId}/versions #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.

Responses

200 OK application/json 
"example"

Schemas: TenantSeedProfileVersionModel

GET /v1/tenant-seed-profiles/{profileId}/versions/{version} #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK application/json 
{
  "profileID": "example_001",
  "displayName": "Example name",
  "version": "example",
  "status": "example",
  "manifestJson": "example",
  "manifestHash": "example",
  "createdByUserID": "example_001",
  "lastUpdatedByUserID": "example_001"
}

Schemas: TenantSeedProfileVersionModel

PUT /v1/tenant-seed-profiles/{profileId}/versions/{version} #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK

Schemas: TenantSeedProfileVersionWriteModel

POST /v1/tenant-seed-profiles/{profileId}/versions/{version}/publish #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK
POST /v1/tenant-seed-profiles/{profileId}/versions/{version}/retire #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK
POST /v1/tenant-seed-profiles/{profileId}/versions/{version}/validate #

Parameters

NameInTypeRequiredDetailsDescription
profileIdpathstringYes The `profileId` route parameter. Required.
versionpathstringYes The `version` route parameter. Required.

Responses

200 OK

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

NameInTypeRequiredDetailsDescription
ReferenceTypequerystringNo The `ReferenceType` query-string parameter.
StatusqueryintegerNo format: int32 default: 1 enum: 0, 1, 2 The `Status` query-string parameter. Optional; defaults to `1`. Internal constants: `0`, `1`, `2`.

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

NameInTypeRequiredDetailsDescription
ToDoIDpathstringYes The `ToDoID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
StatusqueryintegerNo format: int32 default: 1 enum: 0, 1, 2 The `Status` query-string parameter. Optional; defaults to `1`. Internal constants: `0`, `1`, `2`.

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

NameInTypeRequiredDetailsDescription
ReferenceTypequerystringNo The `ReferenceType` query-string parameter.
RolepathstringYes The `Role` route parameter. Required.
StatusqueryintegerNo format: int32 default: 1 enum: 0, 1, 2 The `Status` query-string parameter. Optional; defaults to `1`. Internal constants: `0`, `1`, `2`.

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

NameInTypeRequiredDetailsDescription
SalesOrderIDpathstringYes The `SalesOrderID` route parameter. Required.
StatusqueryintegerNo format: int32 default: 1 enum: 0, 1, 2 The `Status` query-string parameter. Optional; defaults to `1`. Internal constants: `0`, `1`, `2`.

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

NameInTypeRequiredDetailsDescription
SalesQuoteIDpathstringYes The `SalesQuoteID` route parameter. Required.
StatusqueryintegerNo format: int32 default: 1 enum: 0, 1, 2 The `Status` query-string parameter. Optional; defaults to `1`. Internal constants: `0`, `1`, `2`.

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

NameInTypeRequiredDetailsDescription
ToDoIDpathstringYes The `ToDoID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TourIDpathstringYes The `TourID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/tours/{TourID} #

Parameters

NameInTypeRequiredDetailsDescription
TourIDpathstringYes The `TourID` route parameter. Required.

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
DELETE /v1/service/troublereports/{ReportID} #

Parameters

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.

Responses

200 OK
GET /v1/service/troublereports/{ReportID} #

Parameters

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.

Responses

200 OK
PATCH /v1/service/troublereports/{ReportID} #

Parameters

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.

Responses

200 OK

Schemas: TroubleReportModel

GET /v1/service/troublereports/{ReportID}/pdf #

Parameters

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
DocumentIDquerystringYes The `DocumentID` query-string parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
DocumentIDquerystringNo The `DocumentID` query-string parameter.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.

Responses

200 OK
POST /v1/service/troublereports/byids #

Responses

200 OK
POST /v1/service/troublereports/pages/{page} #

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

Responses

200 OK

Schemas: TroubleReportSlicerModel

POST /v1/service/troublereports/prodorders/pages/{page} #

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

Responses

200 OK

Schemas: TroubleReportSlicerModel

GET /v1/service/troublereports/productionorder/{ProductionOrderID} #

Parameters

NameInTypeRequiredDetailsDescription
ProductionOrderIDpathstringYes The `ProductionOrderID` route parameter. Required.

Responses

200 OK
POST /v1/service/troublereports/salesorders/pages/{page} #

Parameters

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 The `RecordsPerPage` query-string parameter.

Responses

200 OK

Schemas: TroubleReportSlicerModel

TroubleReportSymptomImages

GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images #

Parameters

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ReportIDpathstringYes The `ReportID` route parameter. Required.
SymptomIDpathstringYes The `SymptomID` route parameter. Required.
ImageIDpathstringYes The `ImageID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
ProductIDpathstringYes The `ProductID` route parameter. Required.
AttributeIDpathstringYes The `AttributeID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
VerticalIDpathstringYes The `VerticalID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
VerticalIDpathstringYes The `VerticalID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
VerticalIDpathstringYes The `VerticalID` route parameter. Required.

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

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

NameInTypeRequiredDetailsDescription
WebhookIDpathstringYes The `WebhookID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

DELETE /v1/webhooks/{WebHookID} #

Parameters

NameInTypeRequiredDetailsDescription
WebHookIDpathstringYes The `WebHookID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

PATCH /v1/webhooks/{WebHookID} #

Parameters

NameInTypeRequiredDetailsDescription
WebHookIDpathstringYes The `WebHookID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
WebhookIDpathstringYes The `WebhookID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
EntityquerystringNo The `Entity` query-string parameter.
EventquerystringNo The `Event` query-string parameter.

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

NameInTypeRequiredDetailsDescription
pagepathintegerYes format: int32 default: 1 The `page` route parameter. Required. Pages are 1-based.
RecordsPerPagequeryintegerNo format: int32 default: 25 The `RecordsPerPage` query-string parameter. Optional; defaults to `25`.
EntityquerystringNo The `Entity` query-string parameter.
EventquerystringNo The `Event` query-string parameter.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

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

NameInTypeRequiredDetailsDescription
TemplateIDpathstringYes The `TemplateID` route parameter. Required.

Responses

200 OK
401 Unauthorized application/json 
{
  "type": "example",
  "title": "example",
  "status": 0,
  "detail": "example",
  "instance": "example"
}

Schemas: ProblemDetails XmlTemplateModel

Schemas

AnnouncementModelobject
PropertyTypeRequiredDetailsDescription
announcementIDstringNo nullable
messagestringNo nullable
infoUrlstringNo nullable
startDateUTCstringNo format: date-time
endDateUTCstringNo format: date-time nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
appFilterstringNo nullable
roleFilterstringNo nullable
tenantFilterstringNo nullable
isActivebooleanNo

Used by: POST /v1/announcements

AppForgeSettingsModelobject
PropertyTypeRequiredDetailsDescription
stringsobjectNo nullable
terminologyForgeTerminologyModelNo
salesOrderSettingsSalesOrdersSettingsModelNo
salesQuoteSettingsSalesQuotesSettingsModelNo
generalSettingsGeneralSettingsModelNo
paymentSettingsPaymentSettingsModelNo
sftpExportSftpExportSettingsModelNo
configurationReleaseConfigurationReleaseSettingsModelNo
knowledgeGovernanceKnowledgeGovernanceSettingsModelNo
legacyShowSmartQuoteLinkNavstringNo nullable
legacyShowCostAndPricingstringNo nullable
legacyShowBillOfMaterialsstringNo nullable
legacyUsePricingComponentsstringNo nullable
legacyShowItemDetailInLineItemsTablestringNo nullable
legacySalesQuoteAllowSendByEmailstringNo nullable
legacyCustomersAllowAddstringNo nullable
legacyItemsAllowAddstringNo nullable
legacySalesQuoteMetaDataLabelsarray of stringNo nullable
legacySalesOrderNumberPrefixstringNo nullable
legacySalesQuoteNumberFormatstringNo nullable
legacySalesQuoteDefaultPhasestringNo nullable
legacySalesFunnelNumberPrefixstringNo nullable
legacyTimingApproachstringNo nullable
legacySalesOrderPurchaseOrderRequiredstringNo nullable

Used by: POST /v1/instances/{InstanceID}/customization POST /v1/instances/{InstanceID}/settings

ApprovalPolicyModelobject
PropertyTypeRequiredDetailsDescription
policyIDstringNo nullable
appliesTostringNo nullable
levelintegerNo format: int32
currencyIDstringNo nullable
minimumnumberNo format: double
maximumnumberNo format: double
rolestringNo nullable
historyarray of HistoryModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/approval/policies/{PolicyID} POST /v1/approval/policies

AssignmentHistoryModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
createdUTCstringNo format: date-time
AuditActorTypeinteger
AuditModelobject
PropertyTypeRequiredDetailsDescription
tablestringNo nullable
fieldstringNo nullable
recordGuidstringNo nullable
oldValuestringNo nullable
newValuestringNo nullable
changedByUserIDstringNo nullable
changedUTCstringNo format: date-time

Used by: POST /v1/audit

AuditRecordModelobject
PropertyTypeRequiredDetailsDescription
auditIDstringNo nullable
primaryKeyIDstringNo nullable
entitystringNo nullable
propertystringNo nullable
oldValuestringNo nullable
newValuestringNo nullable
actorTypeAuditActorTypeNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
AuditSlicerModelobject
PropertyTypeRequiredDetailsDescription
yearintegerNo format: int32
monthintegerNo format: int32
entityPrefixstringNo nullable

Used by: POST /v1/audit/count POST /v1/audit/pages/{page}

AutomationDesignModelobject
PropertyTypeRequiredDetailsDescription
designIDstringNo nullable
namestringNo nullable
appliesTostringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/automation/designs/{DesignID} POST /v1/automation/designs

AutomationDesignRuleModelobject
PropertyTypeRequiredDetailsDescription
ruleIDstringNo nullable
designIDstringNo nullable
namestringNo nullable
rulestringNo nullable
priorityintegerNo format: int32
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/automation/designs/{DesignID}/rules/{RuleID} POST /v1/automation/designs/{DesignID}/rules

AutomationRunApprovalModelobject
PropertyTypeRequiredDetailsDescription
responsesarray of stringNo nullable
AutomationRunDataobject
PropertyTypeRequiredDetailsDescription
timerAutomationRunTimerModelNo
approvalAutomationRunApprovalModelNo
AutomationRunModelobject
PropertyTypeRequiredDetailsDescription
runIDstringNo nullable
designIDstringNo nullable
statestringNo nullable
descriptionstringNo nullable
dataAutomationRunDataNo
referenceTypestringNo nullable
referenceIDstringNo nullable
historyarray of HistoryModelNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
errorsarray of stringNo nullable
warningsarray of stringNo nullable
informationarray of stringNo nullable

Used by: PATCH /v1/automation/runs/{RunID} POST /v1/automation/runs

AutomationRunTimerModelobject
PropertyTypeRequiredDetailsDescription
expiresUTCstringNo format: date-time
BatchBasisinteger
BatchRequirementModelobject
PropertyTypeRequiredDetailsDescription
requirementIDstringNo nullable
productIDstringNo nullable
sourceTaskIDstringNo nullable
sourceTaskNamestringNo nullable
basisBatchBasisNo
quantityUOMstringNo nullable
customBasisstringNo nullable
attributesobjectNo nullable
CalendarExceptionModelobject
PropertyTypeRequiredDetailsDescription
exceptionIDstringNo nullable
descriptionstringNo nullable
nonWorkingDaystringNo format: date-time
CatalogLookupDefinitionModelobject
PropertyTypeRequiredDetailsDescription
versionintegerNo format: int32
returnCatalogLookupReturnModelNo
filtersarray of CatalogLookupFilterModelNo nullable
CatalogLookupFilterModelobject
PropertyTypeRequiredDetailsDescription
sourcestringNo nullable
fieldstringNo nullable
operatorstringNo nullable
valuestringNo nullable
valueFromAttributestringNo nullable
CatalogLookupReturnModelobject
PropertyTypeRequiredDetailsDescription
sourcestringNo nullable
fieldstringNo nullable
ChangeAnnouncementSourceModelobject

An upcoming change authored as Markdown by this application.

PropertyTypeRequiredDetailsDescription
appIDstringNo nullable
externalIDstringNo nullable
titlestringNo nullable
markdownstringNo nullable
announceUTCstringNo format: date-time
effectiveUTCstringNo format: date-time
contentHashstringNo nullable

Used by: GET /v1/changes/announcements

ChangeOrderModelobject
PropertyTypeRequiredDetailsDescription
changeIDstringNo nullable
descriptionstringNo nullable
detailstringNo nullable
lineItemIDstringNo nullable
costnumberNo format: double
pricenumberNo format: double
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time

Used by: PUT /v1/salesorders/{SalesOrderID}/changeorders

CommercialRelationshipDocumentModelobject
PropertyTypeRequiredDetailsDescription
documentIDstringNo nullable
namestringNo nullable
revisionstringNo nullable
descriptionstringNo nullable
fileNamestringNo nullable
contentTypestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time

Used by: POST /v1/commercial-relationships/{relationshipID}/documents

CommercialRelationshipDocumentUploadModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
revisionstringNo nullable
descriptionstringNo nullable
fileNamestringNo nullable
contentTypestringNo nullable
fileBytesstringNo nullable

Used by: POST /v1/commercial-relationships/{relationshipID}/documents

CommercialRelationshipModelobject
PropertyTypeRequiredDetailsDescription
commercialRelationshipIDstringNo nullable
namestringNo nullable
relationshipTypestringNo nullable
sellingEntitystringNo nullable
supplyingEntitystringNo nullable
agreementIDstringNo nullable
agreementVersionstringNo nullable
descriptionstringNo nullable
documentsarray of CommercialRelationshipDocumentModelNo nullable
linksarray of DocumentLinkModelNo nullable
isActivebooleanNo

Used by: GET /v1/commercial-relationships GET /v1/commercial-relationships/{relationshipID} POST /v1/commercial-relationships PUT /v1/commercial-relationships/{relationshipID}

ConfigurationAnalysisCountModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
valuestringNo nullable
countintegerNo format: int32
ConfigurationAnalysisMonthModelobject
PropertyTypeRequiredDetailsDescription
datestringNo format: date-time
attributesarray of ConfigurationAnalysisCountModelNo nullable

Used by: GET /v1/salesorders/analysis/configurations

ConfigurationAttributeModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
valuestringNo nullable
methodstringNo nullable
sortOrderstringNo nullable
ConfigurationLineItemOptionModelobject
PropertyTypeRequiredDetailsDescription
keystringNo nullable
labelstringNo nullable
displayOrderintegerNo format: int32
benefitsarray of stringNo nullable
benefitDefinitionsarray of GbbBenefitModelNo nullable
fencesarray of GbbFenceModelNo nullable
lineItemLineItemModelNo

Used by: POST /v1/configure/{ProductID}/configuration/selection

ConfigurationLineItemSelectionRequestModelobject
PropertyTypeRequiredDetailsDescription
configurationConfigurationModelNo
setIDstringNo nullable
optionKeystringNo nullable

Used by: POST /v1/configure/{ProductID}/configuration/selection

ConfigurationModelobject
PropertyTypeRequiredDetailsDescription
configurationIDstringNo nullable
productIDstringNo nullable
workInstructionIDstringNo nullable
workInstructionRevisionIDstringNo nullable
scheduleEstimatestringNo nullable
schedulingPrioritystringNo nullable
schedulingNotesstringNo nullable
attributesobjectNo nullable
lineItemSetSelectionsobjectNo nullable
currencyIDstringNo nullable
currencyCurrencyModelNo
salesQuoteIDstringNo nullable
salesOrderIDstringNo nullable
optionsConfigureOptionsModelNo

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
PropertyTypeRequiredDetailsDescription
requireCostbooleanNo
requirePricebooleanNo
requireCurrencybooleanNo
allowZeroCostbooleanNo
allowZeroPricebooleanNo
ConfiguredItemSourcingModelobject
PropertyTypeRequiredDetailsDescription
sourceTypestringNo nullable
supplierIDstringNo nullable
supplierNumberstringNo nullable
catalogUnitCostnumberNo format: double
processesarray of SupplierProcessCostModelNo nullable
ConfigureOptionsModelobject
PropertyTypeRequiredDetailsDescription
versionstringNo nullable
flowModestringNo nullable
onFinishTargetIDstringNo nullable
onFinishTargetLineItemIDstringNo nullable
CopyToTenantModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
randomizeDatastringNo nullable
sanitizeDatastringNo nullable

Used by: POST /v1/customers/{CustomerID}/copyinto POST /v1/items/{ItemID}/copyinto POST /v1/products/{ProductID}/copyinto

CurrencyConversionModelobject
PropertyTypeRequiredDetailsDescription
baseCurrencyIDstringNo nullable
targetCurrencyIDstringNo nullable
baseCurrencyCodestringNo nullable
targetCurrencyCodestringNo nullable
ratenumberNo format: double
rateTimestampUTCstringNo format: date-time
CurrencyModelobject
PropertyTypeRequiredDetailsDescription
currencyIDstringNo nullable
countrystringNo nullable
currencystringNo nullable
codestringNo nullable
symbolstringNo nullable
flagCodestringNo nullable
CustomerAttributeModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
valuestringNo nullable
CustomerBillToModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
customerNumberstringNo nullable
customerNamestringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
phonestringNo nullable
paymentTermsstringNo nullable
CustomerCoordinatesModelobject
PropertyTypeRequiredDetailsDescription
latitudenumberNo format: double
longitudenumberNo format: double
CustomerIncotermModelobject
PropertyTypeRequiredDetailsDescription
termIDstringNo nullable
codestringNo nullable
namestringNo nullable
descriptionstringNo nullable
effectiveYearintegerNo format: int32
locationstringNo nullable
CustomerMetricsModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
instanceIDstringNo nullable
revenueTTMnumberNo format: double
bookingsTTMnumberNo format: double
gpPercentnumberNo format: double
growthRatenumberNo format: double
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/customers/{CustomerID}/metrics

CustomerModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
numberstringNo nullable
customerNumberstringNo nullable
namestringNo nullable
customerNamestringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
coordinatesCustomerCoordinatesModelNo
geocodeStatusstringNo nullable
paymentTermsstringNo nullable
grossMarginTargetnumberNo format: double
maxDaysAllowedintegerNo format: int32
regionstringNo nullable
verticalstringNo nullable
sourcestringNo nullable
isPinnedbooleanNo
isActivebooleanNo
isWebShopbooleanNo
domainstringNo nullable
peoplearray of stringNo nullable
incotermCustomerIncotermModelNo
priceBreakCustomerPriceBreakModelNo
shipToarray of CustomerShipToModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
documentsarray of DocumentModelNo nullable
attributesarray of CustomerAttributeModelNo nullable
lineItemTemplatesarray of LineItemModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: GET /v1/configure/store/customers GET /v1/salesorders/customers PATCH /v1/customers/{CustomerID} PATCH /v1/customers/{CustomerID}/attributes PATCH /v1/customers/batch POST /v1/configure/store/customers POST /v1/customers POST /v1/customers/{CustomerID}/templates POST /v1/salesquotes/pages/{page}/customers PUT /v1/customers/batch

CustomerOrderModelobject
PropertyTypeRequiredDetailsDescription
customerOrderIDstringNo nullable
numberstringNo nullable
statusstringNo nullable
salesOrderIDstringNo nullable
salesOrderItemAndQtyIDstringNo nullable
releaseDateUTCstringNo format: date-time
lenXintegerNo format: int32
widthYintegerNo format: int32
heightZintegerNo format: int32
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
tagsarray of TagModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/customerorders/{CustomerOrderID} PUT /v1/customerorders

CustomerPriceBreakModelobject
PropertyTypeRequiredDetailsDescription
priceBreakIDstringNo nullable
rangesarray of CustomerPriceBreakRangeModelNo nullable
CustomerPriceBreakRangeModelobject
PropertyTypeRequiredDetailsDescription
rangeIDstringNo nullable
minnumberNo format: double
maxnumberNo format: double
discountnumberNo format: double
CustomerSearchModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
customerNumberstringNo nullable
customerNamestringNo nullable
CustomerShipToModelobject
PropertyTypeRequiredDetailsDescription
shipToIDstringNo nullable
customerIDstringNo nullable
namestringNo nullable
numberstringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
phonestringNo nullable
isActivebooleanNo
incotermCustomerIncotermModelNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PUT /v1/customers/{CustomerID}/shipto PUT /v1/customers/{CustomerID}/shipto/batch

CustomersSlicerModelobject
PropertyTypeRequiredDetailsDescription
countrystringNo nullable
regionstringNo nullable
verticalstringNo nullable
attributestringNo nullable
sourcestringNo nullable
termsstringNo nullable
maxDaysAllowedintegerNo format: int32

Used by: POST /v1/customers/count POST /v1/customers/filter POST /v1/customers/pages/{page}

DashboardEscalationItemModelobject
PropertyTypeRequiredDetailsDescription
escalationProductionOrderEscalationModelNo
productionOrderProductionOrderModelNo
salesOrderSalesOrderModelNo
DashboardEscalationsResponseobject
PropertyTypeRequiredDetailsDescription
itemsarray of DashboardEscalationItemModelNo nullable

Used by: GET /v1/dashboard/escalations

DefinitionAttributeAttrAndValueobject
PropertyTypeRequiredDetailsDescription
pairIDstringNo nullable
namestringNo nullable
valuestringNo nullable
DefinitionAttributeModelobject
PropertyTypeRequiredDetailsDescription
attributeIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
hintstringNo nullable
productIDstringNo nullable
hideWhenstringNo nullable
pageIDstringNo nullable
sequenceNumberintegerNo format: int32
dataTypestringNo nullable
unitsstringNo nullable
validSetsarray of DefinitionAttributeValidValuesSetModelNo nullable
selectOrGeneratedstringNo nullable
selectionTypestringNo nullable
showOnQuotestringNo nullable
hideOnQuoteIfDefaultstringNo nullable
isRequiredstringNo nullable
minstringNo nullable
maxstringNo nullable
isActivestringNo nullable
documentsarray of DocumentModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
queryGetValidQueryValidValuesModelNo

Used by: PATCH /v1/attributes/{AttributeID} PATCH /v1/attributes/{AttributeID}/query PATCH /v1/attributes/batch PUT /v1/attributes PUT /v1/attributes/batch

DefinitionAttributeValidValueModelobject
PropertyTypeRequiredDetailsDescription
valueIDstringNo nullable
valuestringNo nullable
descriptionstringNo nullable
sortOrderintegerNo format: int32
inventoryStatusItemLedgerStatusModelNo
pricenumberNo format: double
linksarray of stringNo nullable
DefinitionAttributeValidValuesSetModelobject
PropertyTypeRequiredDetailsDescription
setIDstringNo nullable
descriptionstringNo nullable
attrsAndValuesarray of DefinitionAttributeAttrAndValueNo nullable
valuesarray of DefinitionAttributeValidValueModelNo nullable
defaultValueIDstringNo nullable
catalogAttributestringNo nullable
catalogFiltersarray of DefinitionAttributeAttrAndValueNo nullable
sortOrderintegerNo format: int32
notesarray of NoteModelNo nullable
DefinitionPageModelobject
PropertyTypeRequiredDetailsDescription
pageIDstringNo nullable
pageNamestringNo nullable
sortOrderintegerNo format: int32
productIDstringNo nullable
hideWhenstringNo nullable
showWhenstringNo nullable
hintstringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
attributesarray of DefinitionAttributeModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable

Used by: PATCH /v1/pages/{PageID} PUT /v1/pages PUT /v1/pages/batch

DefinitionResourceGroupModelobject
PropertyTypeRequiredDetailsDescription
resourceGroupIDstringNo nullable
namestringNo nullable
purposestringNo nullable
locationIDstringNo nullable
isActivestringNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/resourcegroups/{ResourceGroupID} PATCH /v1/resourcegroups/{ResourceGroupID}/notes PUT /v1/resourcegroups

DefinitionResourceModelobject
PropertyTypeRequiredDetailsDescription
resourceIDstringNo nullable
namestringNo nullable
aliasstringNo nullable
categorystringNo nullable
locationIDstringNo nullable
qualityAssetIDstringNo nullable
userIDstringNo nullable
acknowledgmentRequiredstringNo nullable
nonWorkingDaysarray of CalendarExceptionModelNo nullable
resourceGroupIDsarray of stringNo nullable
isActivestringNo nullable
capacityResourceCapacityModelNo
workDaysarray of WorkDayModelNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/resources/{ResourceID} PATCH /v1/resources/{ResourceID}/nonworkingdays PATCH /v1/resources/{ResourceID}/notes PUT /v1/resources

DefinitionRuleGroupModelobject
PropertyTypeRequiredDetailsDescription
ruleGroupIDstringNo nullable
groupNamestringNo nullable
groupPriorityintegerNo format: int32
productIDstringNo nullable
historyarray of HistoryModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
DefinitionRuleModelobject
PropertyTypeRequiredDetailsDescription
ruleIDstringNo nullable
ruleNamestringNo nullable
ruleGroupIDstringNo nullable
priorityintegerNo format: int32
rulestringNo nullable
productIDstringNo nullable
purposestringNo nullable
requiresUpdatebooleanNo
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable

Used by: PATCH /v1/rules/{RuleID} PUT /v1/rules PUT /v1/rules/batch

DefinitionTaskActionModelobject
PropertyTypeRequiredDetailsDescription
actionIDstringNo nullable
DefinitionTaskInvitationModelobject
PropertyTypeRequiredDetailsDescription
invitationIDstringNo nullable
supplierIDstringNo nullable
urlstringNo nullable
expiresUTCstringNo format: date-time
DefinitionTaskModelobject
PropertyTypeRequiredDetailsDescription
taskIDstringNo nullable
taskNumberintegerNo format: int32
locationIDstringNo nullable
namestringNo nullable
workCenterstringNo nullable
descriptionstringNo nullable
phasestringNo nullable
pricingComponentstringNo nullable
taskTypestringNo nullable
invitationsarray of DefinitionTaskInvitationModelNo nullable
actionsarray of DefinitionTaskActionModelNo nullable
resourceGroupIDsarray of stringNo nullable
operatingParametersarray of stringNo nullable
modelXMLtimestringNo nullable
modelXMLcoststringNo nullable
markupnumberNo format: double
timeSetup_minnumberNo format: double
timeTeardown_minnumberNo format: double
timeTransfer_minnumberNo format: double
minWait_minnumberNo format: double
maxWait_minnumberNo format: double
waitOnPredecessorstringNo nullable
nestingDefinitionTaskNestingModelNo
workDaysarray of WorkDayModelNo nullable
nonWorkingDaysarray of CalendarExceptionModelNo nullable
isActivestringNo nullable
timeModelsarray of RegressionModelNo nullable
costModelsarray of RegressionModelNo nullable
capacityTaskCapacityModelNo
taskHourlyRatenumberNo format: double
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
groupByAttributestringNo nullable
nestingTypestringNo nullable
limitX_mmnumberNo format: double
limitY_mmnumberNo format: double
limitZ_mmnumberNo format: double
DeliveryModelobject
PropertyTypeRequiredDetailsDescription
deliveryIDstringNo nullable
modestringNo nullable
carrierstringNo nullable
postalCodestringNo nullable
weight_kgnumberNo format: double
length_mmnumberNo format: double
width_mmnumberNo format: double
height_mmnumberNo format: double
costnumberNo format: double
DiagnosticTreeModelobject
PropertyTypeRequiredDetailsDescription
diagnosticTreeIDstringNo nullable
namestringNo nullable
sourcestringNo nullable
linkstringNo nullable
isActivestringNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/service/diagnostictrees/{DiagnosticTreeID} PUT /v1/service/diagnostictrees

DiscussionParticipantModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
rolestringNo nullable

Used by: POST /v1/discussions/threads/{threadId}/participants

DiscussionThreadMessageModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
messageIDstringNo nullable
threadIDstringNo nullable
senderIDstringNo nullable
contentstringNo nullable
createdUTCstringNo format: date-time
typeMessageTypeNo
metadataobjectNo nullable

Used by: POST /v1/discussions/threads/{threadId}/messages PUT /v1/discussions/messages/{messageId}

DiscussionThreadModelobject
PropertyTypeRequiredDetailsDescription
threadIDstringNo nullable
primaryKeyIDstringNo nullable
entityTypestringNo nullable
referenceIdentifierstringNo nullable
topicstringNo nullable
messagesarray of DiscussionThreadMessageModelNo nullable
participantsarray of DiscussionParticipantModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time

Used by: POST /v1/discussions/{primaryKeyId}/threads POST /v1/discussions/threads PUT /v1/discussions/threads/{threadId}

DocumentFilesAuditFindingModelobject
PropertyTypeRequiredDetailsDescription
documentIDstringNo nullable
namestringNo nullable
documentTypestringNo nullable
fileNamestringNo nullable
expectedFileNamestringNo nullable
fileFoundbooleanNo
localFileFoundbooleanNo
s3FileFoundbooleanNo
productIDsarray of stringNo nullable
DocumentFilesAuditModelobject
PropertyTypeRequiredDetailsDescription
sourcestringNo nullable
rootstringNo nullable
documentCountintegerNo format: int32
connectedDocumentCountintegerNo format: int32
localFoundFileCountintegerNo format: int32
s3FoundFileCountintegerNo format: int32
foundFileCountintegerNo format: int32
missingFileCountintegerNo format: int32
orphanedFileCountintegerNo format: int32
documentsarray of DocumentFilesAuditFindingModelNo nullable
orphanedFilesarray of stringNo nullable

Used by: GET /v1/documents/audit/files

DocumentLinkModelobject
PropertyTypeRequiredDetailsDescription
documentLinkIDstringNo nullable
numberstringNo nullable
revisionstringNo nullable
descriptionstringNo nullable
urlstringNo nullable
tagsarray of TagModelNo nullable
scopesarray of stringNo nullable
attributesobjectNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
DocumentModelobject
PropertyTypeRequiredDetailsDescription
documentIDstringNo nullable
namestringNo nullable
revisionstringNo nullable
descriptionstringNo nullable
documentTypestringNo nullable
fileNamestringNo nullable
sortOrderintegerNo format: int32
visibilitystringNo nullable
tagsarray of TagModelNo nullable
attributesobjectNo nullable
productIDsarray of stringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/documents/{DocumentID}

DocumentReferenceModelobject
PropertyTypeRequiredDetailsDescription
referenceIDstringNo nullable
documentIDstringNo nullable
scopesarray of stringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
DocumentUploadModelobject
PropertyTypeRequiredDetailsDescription
documentDocumentModelNo
fileNamestringNo nullable
fileBytesstringNo nullable

Used by: PATCH /v1/documents/{DocumentID}/replace POST /v1/documents POST /v1/salesorders/{SalesOrderID}/documents POST /v1/salesquotes/{SalesQuoteID}/documents

EmailAttachmentModelobject
PropertyTypeRequiredDetailsDescription
pathstringNo nullable
EmailContactModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
emailAddressstringNo nullable
EmailMessageModelobject
PropertyTypeRequiredDetailsDescription
emailIDstringNo nullable
referenceTypestringNo nullable
referenceIDstringNo nullable
statusstringNo nullable
toarray of EmailContactModelNo nullable
ccarray of EmailContactModelNo nullable
bccarray of EmailContactModelNo nullable
attachmentsarray of EmailAttachmentModelNo nullable
subjectstringNo nullable
messagestringNo nullable
isHtmlbooleanNo
createdUTCstringNo format: date-time
createdByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
historyarray of HistoryModelNo nullable

Used by: POST /v1/salesorders/{SalesOrderID}/email POST /v1/salesquotes/{SalesQuoteID}/email/pdf PUT /v1/email PUT /v1/salesfunnel/{OpportunityID}/sendemail

EmailServerModelobject
PropertyTypeRequiredDetailsDescription
displayNamestringNo nullable
loginstringNo nullable
passwordstringNo nullable
hostnamestringNo nullable
portstringNo nullable
levelstringNo nullable
providerstringNo nullable
apiKeystringNo nullable

Used by: PATCH /v1/instances/smtpserver

EmailTemplateModelobject
PropertyTypeRequiredDetailsDescription
templateIDstringNo nullable
instanceIDstringNo nullable
namestringNo nullable
subjectstringNo nullable
bodyHTMLstringNo nullable
bodyTextstringNo nullable
bodystringNo nullable
isActivestringNo nullable
appliesTostringNo nullable
sortOrderintegerNo format: int32
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/email/templates/{TemplateID} POST /v1/email/templates

EmployeeModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
firststringNo nullable
laststringNo nullable
titlestringNo nullable
emailAddressstringNo nullable
phoneNumbersarray of PhoneNumberModelNo nullable
phoneOfficestringNo nullable
phoneMobilestringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
managerUserIDstringNo nullable
resetRequiredstringNo nullable
isActivestringNo nullable
offsetUTCnumberNo format: double
globalRolesarray of stringNo nullable
instanceAccessarray of UserTenantAccessModelNo nullable
profilesarray of UserProfileBaseModelNo nullable

Used by: PATCH /v1/employees/{EmployeeID} PUT /v1/employees

EndCustomerModelobject
PropertyTypeRequiredDetailsDescription
endCustomerIDstringNo nullable
customerIDstringNo nullable
namestringNo nullable
numberstringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
phonestringNo nullable
EscalationTemplateModelobject
PropertyTypeRequiredDetailsDescription
templateIDstringNo nullable
namestringNo nullable
templatestringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/escalation/templates/{TemplateID} POST /v1/escalation/templates

EventSlicerModelobject
PropertyTypeRequiredDetailsDescription
yearintegerNo format: int32
monthintegerNo format: int32

Used by: POST /v1/events/count POST /v1/events/pages/{page}

FactEvidenceModelobject
PropertyTypeRequiredDetailsDescription
factKindstringNo nullable
confidencenumberNo format: double
sourcestringNo nullable
effectiveFromUTCstringNo format: date-time nullable
effectiveThroughUTCstringNo format: date-time nullable
reviewStatusstringNo nullable
reviewedByUserIDstringNo nullable
reviewedUTCstringNo format: date-time nullable
FeatureModelobject
PropertyTypeRequiredDetailsDescription
featureIDstringNo nullable
appIDstringNo nullable
enabledbooleanNo
canEditbooleanNo
notesstringNo nullable
createdUTCstringNo format: date-time
createdByUserIDstringNo nullable
lastUpdateddUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
FeedbackRequestParametersobject
PropertyTypeRequiredDetailsDescription
emailstringNo nullable
messagestringNo nullable
setIDstringNo nullable

Used by: POST /v1/products/{ProductID}/attributes/{AttributeID}/feedback/request

FileUploadModelobject
PropertyTypeRequiredDetailsDescription
fileNamestringNo nullable
fileBytesstringNo nullable

Used by: POST /v1/serialization/import

FilterConditionModelobject
PropertyTypeRequiredDetailsDescription
fieldstringNo nullable
operatorstringNo nullable
valueNo nullable
FilterModeinteger
ForgeAiAttributeModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
pageTemporaryIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
dataTypestringNo nullable
selectionTypestringNo nullable
unitsstringNo nullable
defaultValuestringNo nullable
isRequiredbooleanNo
ForgeAiAttributeValueModelobject
PropertyTypeRequiredDetailsDescription
attributeTemporaryIDstringNo nullable
valuestringNo nullable
ForgeAiBusinessContextModelobject
PropertyTypeRequiredDetailsDescription
businessProblemstringNo nullable
targetMarketstringNo nullable
targetCustomerstringNo nullable
productFamilystringNo nullable
productNamestringNo nullable
productSkustringNo nullable
commercialIntentstringNo nullable
defaultUnitsstringNo nullable
terminologyarray of stringNo nullable
constraintsarray of stringNo nullable
notesstringNo nullable

Used by: POST /v1/forge/ai/jobs

ForgeAiEvidenceModelobject
PropertyTypeRequiredDetailsDescription
evidenceIDstringNo nullable
entityTemporaryIDstringNo nullable
sourceIDstringNo nullable
locationstringNo nullable
excerptstringNo nullable
confidencenumberNo format: double
rationalestringNo nullable
ForgeAiItemMappingModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
conditionsarray of ForgeAiAttributeValueModelNo nullable
itemsarray of ForgeAiItemQuantityModelNo nullable
ForgeAiItemQuantityModelobject
PropertyTypeRequiredDetailsDescription
itemNumberstringNo nullable
quantitynumberNo format: double
ForgeAiPageModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
sortOrderintegerNo format: int32
ForgeAiProductModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
namestringNo nullable
skustringNo nullable
descriptionstringNo nullable
categorystringNo nullable
ForgeAiRuleGroupModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
namestringNo nullable
priorityintegerNo format: int32
ForgeAiRuleModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
ruleGroupTemporaryIDstringNo nullable
namestringNo nullable
expressionstringNo nullable
priorityintegerNo format: int32
ForgeAiSetupJobModelobject
PropertyTypeRequiredDetailsDescription
jobIDstringNo nullable
instanceIDstringNo nullable
productIDstringNo nullable
statestringNo nullable
rowVersionintegerNo format: int64
businessContextForgeAiBusinessContextModelNo
packageForgeAiSetupPackageModelNo
validationForgeAiValidationReportModelNo
processingStatusstringNo nullable
processingMessagestringNo nullable
modelNamestringNo nullable
promptVersionstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
schemaVersionintegerNo format: int32
businessContextForgeAiBusinessContextModelNo
productForgeAiProductModelNo
pagesarray of ForgeAiPageModelNo nullable
attributesarray of ForgeAiAttributeModelNo nullable
validValueSetsarray of ForgeAiValidValueSetModelNo nullable
ruleGroupsarray of ForgeAiRuleGroupModelNo nullable
rulesarray of ForgeAiRuleModelNo nullable
itemMappingsarray of ForgeAiItemMappingModelNo nullable
evidencearray of ForgeAiEvidenceModelNo nullable
warningsarray of stringNo nullable
ForgeAiSetupSourceModelobject
PropertyTypeRequiredDetailsDescription
sourceIDstringNo nullable
jobIDstringNo nullable
sourceTypestringNo nullable
originalFileNamestringNo nullable
urlstringNo nullable
storageKeystringNo nullable
mimeTypestringNo nullable
checksumstringNo nullable
extractionStatestringNo nullable
extractedContentstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time

Used by: POST /v1/forge/ai/jobs/{jobID}/sources

ForgeAiTransitionRequestModelobject
PropertyTypeRequiredDetailsDescription
commandstringNo nullable
rowVersionintegerNo format: int64

Used by: POST /v1/forge/ai/jobs/{jobID}/transitions

ForgeAiTransitionResultModelobject
PropertyTypeRequiredDetailsDescription
succeededbooleanNo
previousStatestringNo nullable
statestringNo nullable
errorstringNo nullable
allowedCommandsarray of stringNo nullable

Used by: POST /v1/forge/ai/jobs/{jobID}/transitions

ForgeAiUpdateBusinessContextRequestModelobject
PropertyTypeRequiredDetailsDescription
rowVersionintegerNo format: int64
businessContextForgeAiBusinessContextModelNo

Used by: PATCH /v1/forge/ai/jobs/{jobID}/context

ForgeAiUpdatePackageRequestModelobject
PropertyTypeRequiredDetailsDescription
rowVersionintegerNo format: int64
packageForgeAiSetupPackageModelNo

Used by: PATCH /v1/forge/ai/jobs/{jobID}/package

ForgeAiValidationFindingModelobject
PropertyTypeRequiredDetailsDescription
findingIDstringNo nullable
severitystringNo nullable
codestringNo nullable
messagestringNo nullable
entityTemporaryIDstringNo nullable
ForgeAiValidationReportModelobject
PropertyTypeRequiredDetailsDescription
findingsarray of ForgeAiValidationFindingModelNo nullable
hasBlockingFindingsbooleanNo
ForgeAiValidValueSetModelobject
PropertyTypeRequiredDetailsDescription
temporaryIDstringNo nullable
attributeTemporaryIDstringNo nullable
descriptionstringNo nullable
defaultValuestringNo nullable
valuesarray of stringNo nullable
ForgeTerminologyModelobject
PropertyTypeRequiredDetailsDescription
quotesNavigationstringNo nullable
ordersNavigationstringNo nullable
smartQuotestringNo nullable
salesstringNo nullable
salesQuotestringNo nullable
salesQuotesstringNo nullable
ordersstringNo nullable
salesOrderstringNo nullable
salesOrdersstringNo nullable
customerstringNo nullable
customersstringNo nullable
productionstringNo nullable
productionOrderstringNo nullable
productionOrdersstringNo nullable
daysElapsedstringNo nullable
notesstringNo nullable
GbbApplicabilityModelobject
PropertyTypeRequiredDetailsDescription
enabledbooleanNo
allowedVerticalsarray of stringNo nullable
allowedRegionsarray of stringNo nullable
allowedCustomerTypesarray of stringNo nullable
requiredFlagsarray of stringNo nullable
requiredProductAttributesarray of stringNo nullable
GbbBenefitModelobject
PropertyTypeRequiredDetailsDescription
benefitIDstringNo nullable
setIDstringNo nullable
codestringNo nullable
displayNamestringNo nullable
descriptionstringNo nullable
displayNameOverridestringNo nullable
descriptionOverridestringNo nullable
displayOrderintegerNo format: int32
isIncludedbooleanNo
GbbCatalogEntryModelobject
PropertyTypeRequiredDetailsDescription
entryIDstringNo nullable
codestringNo nullable
displayNamestringNo nullable
descriptionstringNo nullable
displayOrderintegerNo format: int32
isActivebooleanNo
GbbCatalogModelobject
PropertyTypeRequiredDetailsDescription
benefitsarray of GbbCatalogEntryModelNo nullable
fencesarray of GbbCatalogEntryModelNo nullable

Used by: PATCH /v1/instances/gbb-catalog

GbbDesignSetModelobject
PropertyTypeRequiredDetailsDescription
setIDstringNo nullable
namestringNo nullable
priorityintegerNo format: int32
applicabilityGbbApplicabilityModelNo
tiersobjectNo nullable
GbbDisplayItemSnapshotModelobject
PropertyTypeRequiredDetailsDescription
codestringNo nullable
displayNamestringNo nullable
descriptionstringNo nullable
displayOrderintegerNo format: int32
fenceEffectGbbFenceEffectNo
GbbDisplaySnapshotModelobject
PropertyTypeRequiredDetailsDescription
designSetIDstringNo nullable
tierKeystringNo nullable
tierLabelstringNo nullable
benefitsarray of GbbDisplayItemSnapshotModelNo nullable
fencesarray of GbbDisplayItemSnapshotModelNo nullable
GbbFenceEffectinteger
GbbFenceModelobject
PropertyTypeRequiredDetailsDescription
fenceIDstringNo nullable
setIDstringNo nullable
codestringNo nullable
displayNamestringNo nullable
descriptionstringNo nullable
displayNameOverridestringNo nullable
descriptionOverridestringNo nullable
displayOrderintegerNo format: int32
effectGbbFenceEffectNo
GbbPriceModeinteger
GbbTierinteger
GbbTierDefinitionModelobject
PropertyTypeRequiredDetailsDescription
tierIDstringNo nullable
setIDstringNo nullable
tierGbbTierNo
skustringNo nullable
priceModeGbbPriceModeNo
priceOverridenumberNo format: double nullable
priceFactornumberNo format: double nullable
benefitsarray of GbbBenefitModelNo nullable
fencesarray of GbbFenceModelNo nullable
GeneralSettingsModelobject
PropertyTypeRequiredDetailsDescription
showSmartQuoteLinkNavstringNo nullable
showCostAndPricingstringNo nullable
showBillOfMaterialsstringNo nullable
usePricingComponentsstringNo nullable
showItemDetailInLineItemsTablestringNo nullable
salesQuoteAllowSendByEmailstringNo nullable
customersAllowAddstringNo nullable
itemsAllowAddstringNo nullable
salesQuoteMetaDataLabelsarray of stringNo nullable
salesOrderNumberPrefixstringNo nullable
salesQuoteNumberFormatstringNo nullable
salesQuoteDefaultPhasestringNo nullable
salesFunnelNumberPrefixstringNo nullable
timingApproachstringNo nullable
GlobalSearchLiteResultModelobject
PropertyTypeRequiredDetailsDescription
serviceTicketsarray of ServiceTicketModelNo nullable
serialsarray of SerializationSerialNumberModelNo nullable
salesQuotesarray of SalesQuoteModelNo nullable
salesOrdersarray of SalesOrderModelNo nullable
customersarray of CustomerSearchModelNo nullable
productionOrdersarray of ProductionOrderModelNo nullable
itemsarray of ItemSearchModelNo nullable
itemCompatibilitiesarray of ItemCompatibilityModelNo nullable
salesTargetsarray of SalesOpportunityModelNo nullable
queuesarray of ProductionQueueModelNo nullable
qualityNcrarray of QualityNcrModelNo nullable
qualityAssetsarray of QualityAssetModelNo nullable
suppliersarray of SupplierModelNo nullable
productionOrderCustomersobjectNo nullable

Used by: POST /v1/search/lite-customer-items

GlobalSearchRequestModelobject
PropertyTypeRequiredDetailsDescription
querystringNo nullable
scopestringNo nullable
limitintegerNo format: int32

Used by: POST /v1/search POST /v1/search/lite-customer-items

GlobalSearchResultModelobject
PropertyTypeRequiredDetailsDescription
serviceTicketsarray of ServiceTicketModelNo nullable
serialsarray of SerializationSerialNumberModelNo nullable
salesQuotesarray of SalesQuoteModelNo nullable
salesOrdersarray of SalesOrderModelNo nullable
customersarray of CustomerModelNo nullable
productionOrdersarray of ProductionOrderModelNo nullable
itemsarray of ItemModelNo nullable
itemCompatibilitiesarray of ItemCompatibilityModelNo nullable
salesTargetsarray of SalesOpportunityModelNo nullable
queuesarray of ProductionQueueModelNo nullable
qualityNcrarray of QualityNcrModelNo nullable
qualityAssetsarray of QualityAssetModelNo nullable
suppliersarray of SupplierModelNo nullable
productionOrderCustomersobjectNo nullable

Used by: POST /v1/search

GovernedItemPricingModelobject
PropertyTypeRequiredDetailsDescription
costSourcestringNo nullable
unitCostnumberNo format: double
policyIDstringNo nullable
policyVersionstringNo nullable
policySourcestringNo nullable
targetMarginPercentnumberNo format: double
unitPricenumberNo format: double
currencyIDstringNo nullable
effectiveFromUTCstringNo format: date-time nullable
effectiveThroughUTCstringNo format: date-time nullable
calculatedUTCstringNo format: date-time
reviewedByUserIDstringNo nullable
reviewedUTCstringNo format: date-time

Used by: GET /v1/salesquotes/{SalesQuoteID}/items/{ItemID}/pricing

HeatMapDataModelobject
PropertyTypeRequiredDetailsDescription
xintegerNo format: int32
yintegerNo format: int32
valueintegerNo format: int32
HistoryModelobject
PropertyTypeRequiredDetailsDescription
historyIDstringNo nullable
activitystringNo nullable
byUserIDstringNo nullable
dateTimeUTCstringNo format: date-time
HomeModelobject
PropertyTypeRequiredDetailsDescription
recentViewsobjectNo nullable
phasesQuotesarray of PhaseModelNo nullable
phasesProductionarray of PhaseModelNo nullable
notesarray of NoteWithParentIdModelNo nullable
toDoFunnelarray of ToDoModelNo nullable
toDoSalesQuotesarray of ToDoModelNo nullable
toDoSalesOrdersarray of ToDoModelNo nullable
tourUserTourModelNo
isResourceAssignedbooleanNo
nonWorkingDaysarray of CalendarExceptionModelNo nullable
escalationsDashboardEscalationsResponseNo
countsSalesQuotesobjectNo nullable
countsSalesOrdersobjectNo nullable
countsProductionOrdersobjectNo nullable
countsTroubleReportsobjectNo nullable
promotionsarray of PromotionModelNo nullable
teamsarray of TeamModelNo nullable
recentSalesQuotesarray of SalesQuoteModelNo nullable
recentSalesOrdersarray of SalesOrderModelNo nullable

Used by: GET /v1/home/dashboard

ImageModelobject
PropertyTypeRequiredDetailsDescription
imageIDstringNo nullable
descriptionstringNo nullable
fileNamestringNo nullable
commentsstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/prodorders/{ProductionOrderID}/images/{ImageID} PATCH /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}

ImportMessageModelobject
PropertyTypeRequiredDetailsDescription
logIDstringNo nullable
lineNumberintegerNo format: int32
messagestringNo nullable
logTypestringNo nullable
datastringNo nullable
ImportResultModelobject
PropertyTypeRequiredDetailsDescription
importIDstringNo nullable
messagesarray of ImportMessageModelNo nullable
errorsarray of ImportMessageModelNo nullable
statusstringNo nullable
operationTypestringNo nullable
linesProcessedintegerNo format: int32
fileNamestringNo nullable
timeRequirednumberNo format: double
createdintegerNo format: int32
updatedintegerNo format: int32
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: GET /v1/salesorders/import/results POST /v1/salesorders/import

IncotermDefinitionModelobject
PropertyTypeRequiredDetailsDescription
termIDstringNo nullable
codestringNo nullable
namestringNo nullable
descriptionstringNo nullable
effectiveYearintegerNo format: int32
modeIncotermModeNo

Used by: PATCH /v1/global/incoterms/{TermID} POST /v1/global/incoterms

IncotermModeinteger
InstanceModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
tenantIDstringNo nullable
organizationIDstringNo nullable
companyNamestringNo nullable
namestringNo nullable
websitestringNo nullable
allowedCountriesstringNo nullable
currencyIDstringNo nullable
currencyIDsarray of stringNo nullable
unitsWeightstringNo nullable
unitsLengthstringNo nullable
offsetUTCnumberNo format: double
timeZoneIDstringNo nullable
defaultMarkupnumberNo format: double
gbbCatalogGbbCatalogModelNo
schedulingAlgorithmSchedulingAlgorithmModelNo
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
phonestringNo nullable
culturestringNo nullable
defaultPaymentTermsstringNo nullable
tenantTypestringNo nullable
instanceTypestringNo nullable
storeRequireLoginstringNo nullable
subscriptionExpiresUTCstringNo format: date-time
featureSalesFunnelstringNo nullable
featuresobjectNo nullable
featureConfiguratorstringNo nullable
featureBuilderstringNo nullable
featureSalesQuotesstringNo nullable
featureSalesOrdersstringNo nullable
featureBidsstringNo nullable
featureProductionstringNo nullable
featureServicestringNo nullable
featureStorestringNo nullable
featureMaintenancestringNo nullable
featureShippingstringNo nullable
featurePromotionsstringNo nullable
featureDeliverystringNo nullable
featureSuppliersstringNo nullable
featureInvoicingstringNo nullable
featurePurchasingstringNo nullable
featureWarehousestringNo nullable
featureQualitystringNo nullable
featureHelpstringNo nullable
featureCompanystringNo nullable
emailCcarray of EmailContactModelNo nullable
incotermOrganizationIncotermModelNo
integrationJustPlanItIntegrationJustPlanItModelNo
integrationQuickBooksIntegrationQuickBooksModelNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
updatedTUTCstringNo format: date-time
InstanceTypeUpdateRequestobject
PropertyTypeRequiredDetailsDescription
instanceTypestringNo nullable

Used by: PATCH /v1/instances/{InstanceID}/type

InstructionDetailModelobject
PropertyTypeRequiredDetailsDescription
instructionstringNo nullable
time_minintegerNo format: int32
InstructionModelobject
PropertyTypeRequiredDetailsDescription
instructionIDstringNo nullable
productIDstringNo nullable
taskIDstringNo nullable
descriptionstringNo nullable
appliesWhenstringNo nullable
instructionsarray of InstructionDetailModelNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/instructions/{taskid}

Int32ApiResponseModelobject
PropertyTypeRequiredDetailsDescription
successbooleanNo
messagestringNo nullable
errorsarray of stringNo nullable
errorCodestringNo nullable
dataintegerNo format: int32

Used by: PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute

IntegrationActionModelobject
PropertyTypeRequiredDetailsDescription
actionIDstringNo nullable
providerstringNo nullable
labelstringNo nullable
sortOrderintegerNo format: int32
showOnstringNo nullable
requiresConfirmationbooleanNo
isActivebooleanNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
IntegrationExecuteRequestModelobject
PropertyTypeRequiredDetailsDescription
actionIDstringNo nullable
entityIDstringNo nullable

Used by: PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute

IntegrationHelcimConfigModelobject
PropertyTypeRequiredDetailsDescription
accountIDstringNo nullable
apiTokenstringNo nullable
environmentstringNo nullable
webhookSecretstringNo nullable
isActivestringNo nullable
IntegrationJustPlanItModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
apikeystringNo nullable
statusesToSendarray of integerNo nullable
weeksDataToSendintegerNo format: int32
isActivestringNo nullable
IntegrationModelobject
PropertyTypeRequiredDetailsDescription
integrationIDstringNo nullable
namestringNo nullable
providerstringNo nullable
providerJSONstringNo nullable
actionsarray of IntegrationActionModelNo nullable
helcimConfigIntegrationHelcimConfigModelNo
slackConfigIntegrationSlackConfigModelNo
isActivebooleanNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: GET /v1/instances/{InstanceID}/integrations GET /v1/instances/{InstanceID}/integrations/{IntegrationID}

IntegrationQuickBooksModelobject
PropertyTypeRequiredDetailsDescription
clientIDstringNo nullable
clientSecretstringNo nullable
isActivestringNo nullable
IntegrationSlackConfigModelobject
PropertyTypeRequiredDetailsDescription
webhooksarray of SlackWebhookDefinitionNo nullable
InvoiceLineModelobject
PropertyTypeRequiredDetailsDescription
invoiceLineIDstringNo nullable
lineItemIDstringNo nullable
descriptionstringNo nullable
unitPricenumberNo format: double
quantitynumberNo format: double
sourceProposalLineIDstringNo nullable
sourceSubscriptionItemIDstringNo nullable
sourceProjectIDstringNo nullable
sourceTaskIDstringNo nullable
sourceMilestoneIDstringNo nullable
sourceTimeEntryIDsarray of stringNo nullable
InvoiceModelobject
PropertyTypeRequiredDetailsDescription
invoiceIDstringNo nullable
numberstringNo nullable
statusstringNo nullable
customerIDstringNo nullable
salesOrderIDstringNo nullable
currencyIDstringNo nullable
personBillToPersonModelNo
personShipToPersonModelNo
billToCustomerBillToModelNo
shipToCustomerShipToModelNo
linesarray of InvoiceLineModelNo nullable
auditMetadataobjectNo nullable
subscriptionIDstringNo nullable
billingPeriodStartUTCstringNo format: date-time nullable
billingPeriodEndUTCstringNo format: date-time nullable
dueUTCstringNo format: date-time
paidUTCstringNo format: date-time
notesstringNo nullable
termsstringNo nullable
historyarray of HistoryModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/instance/invoices/{InvoiceID} PATCH /v1/invoices/{InvoiceID} PUT /v1/instance/invoices PUT /v1/invoices

ItemAndQtyModelobject
PropertyTypeRequiredDetailsDescription
itemAndQtyIDstringNo nullable
lineNumberintegerNo format: int32
detailsItemModelNo
quantitynumberNo format: double
discountnumberNo format: double
baseUnitPricenumberNo format: double
governedPricingGovernedItemPricingModelNo
statusstringNo nullable
showSubTotalstringNo nullable
referenceIDstringNo nullable
isCustombooleanNo
equivalentItemNumbersarray of stringNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
documentNamesarray of stringNo nullable
documentIDsarray of stringNo nullable

Used by: PUT /v1/salesquotes/{SalesQuoteID}/items

ItemAttributeCategoryApplicabilityModelobject
PropertyTypeRequiredDetailsDescription
itemAttributeDefinitionIDstringNo nullable
categoryIDstringNo nullable
categoryNamestringNo nullable
ItemAttributeControlledValueModelobject
PropertyTypeRequiredDetailsDescription
itemAttributeValueIDstringNo nullable
itemAttributeDefinitionIDstringNo nullable
valuestringNo nullable
isActivestringNo nullable
ItemAttributeDefinitionModelobject
PropertyTypeRequiredDetailsDescription
itemAttributeDefinitionIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
dataTypestringNo nullable
unitsstringNo nullable
ownerstringNo nullable
applicableCategoriesarray of stringNo nullable
categoryApplicabilitiesarray of ItemAttributeCategoryApplicabilityModelNo nullable
aliasesarray of stringNo nullable
controlledValuesarray of ItemAttributeControlledValueModelNo nullable
isActivestringNo nullable
usageCountintegerNo format: int32

Used by: PATCH /v1/items/attribute-definitions/{id} POST /v1/items/attribute-definitions

ItemAttributeMergeModelobject
PropertyTypeRequiredDetailsDescription
targetItemAttributeDefinitionIDstringNo nullable
itemsMovedintegerNo format: int32
conflictingItemsintegerNo format: int32

Used by: POST /v1/items/attribute-definitions/{id}/merge

ItemAttributeModelobject
PropertyTypeRequiredDetailsDescription
itemAttributeDefinitionIDstringNo nullable
itemAttributeValueIDstringNo nullable
namestringNo nullable
valuestringNo nullable
suppliedNamestringNo nullable
provenanceSourcestringNo nullable
provenanceReferencestringNo nullable
provenanceUTCstringNo format: date-time nullable
ItemCompatibilityModelobject
PropertyTypeRequiredDetailsDescription
compatibilityIDstringNo nullable
instanceIDstringNo nullable
baseItemIDstringNo nullable
compatibleItemIDstringNo nullable
baseSubjectKnowledgeRelationshipSubjectModelNo
relatedSubjectKnowledgeRelationshipSubjectModelNo
compatibilityTypestringNo nullable
applicabilityItemRelationshipApplicabilityModelNo
sourceMetadataItemRelationshipSourceMetadataModelNo
lifecycleItemRelationshipLifecycleModelNo
derivationItemRelationshipDerivationModelNo
evidenceFactEvidenceModelNo
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time

Used by: POST /v1/items/compatibility PUT /v1/items/compatibility/{CompatibilityID}

ItemComponentModelobject
PropertyTypeRequiredDetailsDescription
componentItemIDstringNo nullable
quantitynumberNo format: double
ItemCostHistoryModelobject
PropertyTypeRequiredDetailsDescription
dateTimeUTCstringNo format: date-time
costnumberNo format: double
createdByUserIDstringNo nullable
ItemCostReviewEntryModelobject
PropertyTypeRequiredDetailsDescription
entryIDstringNo nullable
itemIDintegerNo format: int32
productIDintegerNo format: int32
costPreviousnumberNo format: double
costCurrentnumberNo format: double
costNewnumberNo format: double
variancenumberNo format: double
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
ItemCostReviewModelobject
PropertyTypeRequiredDetailsDescription
reviewIDstringNo nullable
reviewMonthstringNo format: date-time
reviewerUserIDstringNo nullable
approvedByUserIDintegerNo format: int32
statusReviewStatusNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
entriesarray of ItemCostReviewEntryModelNo nullable

Used by: PATCH /v1/items/reviews/{ReviewID}/basics PUT /v1/items/reviews

ItemImportFieldRuleModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
typestringNo nullable
requiredForCreatebooleanNo
requiredForUpdatebooleanNo
ItemImportRuleModelobject
PropertyTypeRequiredDetailsDescription
codestringNo nullable
fieldstringNo nullable
appliesTostringNo nullable
severitystringNo nullable
constraintstringNo nullable
failureBehaviorstringNo nullable
ItemImportRulesModelobject
PropertyTypeRequiredDetailsDescription
contractVersionstringNo nullable
resourcestringNo nullable
importSemanticsstringNo nullable
supportedFormatsarray of stringNo nullable
fieldsarray of ItemImportFieldRuleModelNo nullable
rulesarray of ItemImportRuleModelNo nullable

Used by: GET /v1/imports/items/rules

ItemLedgerStatusModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
uomstringNo nullable
quantitynumberNo format: double
locationIDstringNo nullable
ItemMappingAttrAndValueobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
valuestringNo nullable
ItemMappingItemAndQtyobject
PropertyTypeRequiredDetailsDescription
numberstringNo nullable
quantitynumberNo format: double
inventoryStatusItemLedgerStatusModelNo
ItemMappingModelobject
PropertyTypeRequiredDetailsDescription
productIDstringNo nullable
itemMappingIDstringNo nullable
categorystringNo nullable
itemsarray of ItemMappingItemAndQtyNo nullable
attributesAndValuesarray of ItemMappingAttrAndValueNo nullable
historyarray of HistoryModelNo nullable
linksarray of DocumentLinkModelNo nullable
errorsarray of stringNo nullable
commentstringNo nullable
requiresUpdatebooleanNo
isRequiredbooleanNo
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/itemmapping PATCH /v1/itemmapping/{ItemMappingID}/history PUT /v1/itemmapping

ItemModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
descriptionstringNo nullable
longDescriptionstringNo nullable
fullDescriptionstringNo nullable
numberstringNo nullable
uomstringNo nullable
categorystringNo nullable
componentsarray of ItemComponentModelNo nullable
parentItemIDstringNo nullable
weightPerUnitnumberNo format: double
unitCostnumberNo format: double
unitPricenumberNo format: double
grossMarginFloornumberNo format: double
pricingFloornumberNo format: double
minimumAcceptablePricenumberNo format: double
pricingComponentstringNo nullable
leadTimeDaysintegerNo format: int32
minimumOrderQuantitynumberNo format: double
leadTimeWeeksnumberNo format: double
originCountryIDstringNo nullable
htsstringNo nullable
eccnstringNo nullable
intercompanyTermstringNo nullable
serializationRequiredstringNo nullable
traceablityRequiredstringNo nullable
isActivestringNo nullable
isDeletedbooleanNo
lifecycleStatusstringNo nullable
availabilityStatusstringNo nullable
availabilityEffectiveUTCstringNo format: date-time nullable
availabilityReasonstringNo nullable
successorItemIDstringNo nullable
statusUpdatedUTCstringNo format: date-time nullable
isInventorystringNo nullable
priceBreaksarray of ItemPriceBreakModelNo nullable
routerarray of ItemTaskModelNo nullable
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
documentsarray of DocumentModelNo nullable
linksarray of DocumentLinkModelNo nullable
attributesarray of ItemAttributeModelNo nullable
costHistoryarray of ItemCostHistoryModelNo nullable
supplierItemNumbersarray of ItemSupplierProductModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
breakIDstringNo nullable
quantityMinnumberNo format: double
quantityMaxnumberNo format: double
pricenumberNo format: double
ItemQuoteReadinessModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
pricingSourcestringNo nullable
costSourcestringNo nullable
approvedUnitCostnumberNo format: double nullable
currencyIDstringNo nullable
effectiveFromUTCstringNo format: date-time nullable
effectiveThroughUTCstringNo format: date-time nullable
reviewStatusstringNo nullable
reviewedByUserIDstringNo nullable
reviewedUTCstringNo format: date-time nullable
notesstringNo nullable

Used by: PUT /v1/items/{itemID}/quote-readiness

ItemRelationshipApplicabilityModelobject
PropertyTypeRequiredDetailsDescription
scopestringNo nullable
conditionsarray of ItemRelationshipConditionModelNo nullable
ItemRelationshipConditionModelobject
PropertyTypeRequiredDetailsDescription
keystringNo nullable
operatorstringNo nullable
valuestringNo nullable
valueTypestringNo nullable
ItemRelationshipDerivationModelobject
PropertyTypeRequiredDetailsDescription
methodstringNo nullable
ruleIDstringNo nullable
ruleVersionstringNo nullable
inputSnapshotHashstringNo nullable
derivedFromCompatibilityIDsarray of stringNo nullable
generatedUTCstringNo format: date-time nullable
ItemRelationshipLifecycleModelobject
PropertyTypeRequiredDetailsDescription
supersedesCompatibilityIDstringNo nullable
revokedByUserIDstringNo nullable
revokedUTCstringNo format: date-time nullable
revocationReasonstringNo nullable
isRevokedbooleanNo
ItemRelationshipReviewRequestobject
PropertyTypeRequiredDetailsDescription
decisionstringNo nullable
commentstringNo nullable

Used by: POST /v1/items/compatibility/{CompatibilityID}/review

ItemRelationshipSourceMetadataModelobject
PropertyTypeRequiredDetailsDescription
documentstringNo nullable
referenceUrlstringNo nullable
revisionstringNo nullable
ItemReviewModelobject
PropertyTypeRequiredDetailsDescription
itemItemModelNo
coststringNo nullable
pricestringNo nullable

Used by: PUT /v1/items/{ItemID}/review

ItemSearchModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
ItemSerializationModelobject
PropertyTypeRequiredDetailsDescription
itemSerializationIDstringNo nullable
itemAndQtyIDstringNo nullable
serialNumberstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
ItemsSlicerModelobject
PropertyTypeRequiredDetailsDescription
isActivestringNo nullable
deletedstringNo nullable
hasAttributesstringNo nullable
lifecycleStatusstringNo nullable
availabilityStatusstringNo nullable
searchForstringNo nullable
categorystringNo nullable
countryIDstringNo nullable
unitCostnumberNo format: double
unitPricenumberNo format: double
sortBystringNo nullable
sortOrderstringNo nullable

Used by: POST /v1/items/analysis/costandprice POST /v1/items/count POST /v1/items/pages/{page}

ItemStoreAvailabilityModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
availableForStorebooleanNo

Used by: GET /v1/items/{itemID}/store PATCH /v1/items/{itemID}/store

ItemSupplierProductModelobject
PropertyTypeRequiredDetailsDescription
supplierIDstringNo nullable
supplierProductNumberstringNo nullable
uomstringNo nullable
leadTimeDaysintegerNo format: int32
isPreferredbooleanNo
lastCostDatestringNo format: date-time nullable
priceBreaksarray of SupplierPriceBreakModelNo nullable
ItemTaskModelobject
PropertyTypeRequiredDetailsDescription
itemTaskIDstringNo nullable
numberintegerNo format: int32
namestringNo nullable
workCenterstringNo nullable
detailstringNo nullable
time_MINnumberNo format: double
cost_CURnumberNo format: double
price_CURnumberNo format: double
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
ItemTraceabilityModelobject
PropertyTypeRequiredDetailsDescription
itemTraceabilityIDstringNo nullable
itemAndQtyIDstringNo nullable
lotNumberstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
JTokenarray of JToken

Used by: PATCH /v1/customers/{CustomerID}/shipto/{ShipToID}

KnowledgeGovernanceSettingsModelobject
PropertyTypeRequiredDetailsDescription
requireSeparateReviewerbooleanNo
recognitionKnowledgeRecognitionSettingsModelNo
KnowledgeRecognitionSettingsModelobject
PropertyTypeRequiredDetailsDescription
enabledbooleanNo
scoreVisibilitystringNo nullable
displayTeamsInsteadOfPeoplebooleanNo
allowNamedRankingOptOutbooleanNo
weeklyLeaderboardbooleanNo
monthlyLeaderboardbooleanNo
pilotLeaderboardbooleanNo
taskAcceptedPointsintegerNo format: int32
qualityWindowPointsintegerNo format: int32
conflictResolvedPointsintegerNo format: int32
coverageGapClosedPointsintegerNo format: int32
onTimeReviewPointsintegerNo format: int32
evidenceRenewedPointsintegerNo format: int32
coverageMilestonePointsintegerNo format: int32
helpfulCorrectionPointsintegerNo format: int32
KnowledgeRelationshipSubjectModelobject
PropertyTypeRequiredDetailsDescription
subjectTypestringNo nullable
subjectIDstringNo nullable
versionstringNo nullable
LineItemAttrModelobject
PropertyTypeRequiredDetailsDescription
lineItemAttrIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
methodstringNo nullable
attributeDataTypestringNo nullable
attributeValuestringNo nullable
attributeUnitsstringNo nullable
LineItemChargeModelobject
PropertyTypeRequiredDetailsDescription
chargeIDstringNo nullable
typestringNo nullable
descriptionstringNo nullable
codestringNo nullable
ratenumberNo format: double
basisstringNo nullable
amountnumberNo format: double
ruleSourcestringNo nullable
LineItemItemAndQtyModelobject
PropertyTypeRequiredDetailsDescription
itemAndQtyIDstringNo nullable
detailsLineItemItemModelNo
quantitynumberNo format: double
referenceIDstringNo nullable
batchNumberstringNo nullable
sourcingConfiguredItemSourcingModelNo
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
notesarray of NoteModelNo nullable
documentNamesarray of stringNo nullable
documentIDsarray of stringNo nullable
LineItemItemModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
descriptionstringNo nullable
numberstringNo nullable
uomstringNo nullable
unitCostnumberNo format: double
unitPricenumberNo format: double
categorystringNo nullable
originCountryIDstringNo nullable
htsstringNo nullable
eccnstringNo nullable
pricingComponentstringNo nullable
leadTimeDaysintegerNo format: int32
serializationRequiredstringNo nullable
traceablityRequiredstringNo nullable
documentsarray of DocumentModelNo nullable
linksarray of DocumentLinkModelNo nullable
referencesRulesarray of ReferenceModelNo nullable
referencesDynBOMarray of ReferenceModelNo nullable
referencesAttributesarray of ReferenceModelNo nullable
LineItemModelobject
PropertyTypeRequiredDetailsDescription
lineItemIDstringNo nullable
lineNumberintegerNo format: int32
productIDstringNo nullable
workInstructionIDstringNo nullable
workInstructionRevisionIDstringNo nullable
fingerPrintstringNo nullable
sourceDocumentIDstringNo nullable
effectiveSourceDocumentIDstringNo nullable
sourceLineItemIDstringNo nullable
configurationSetIDstringNo nullable
configurationOptionKeystringNo nullable
gbbDisplaySnapshotGbbDisplaySnapshotModelNo
hasConfigurationSelectionbooleanNo
isBatchLinebooleanNo
batchIDstringNo nullable
batchChargeLineIDstringNo nullable
batchSourceLineItemIDsarray of stringNo nullable
hasBatchSourceLineItemsbooleanNo
descriptionstringNo nullable
longDescriptionstringNo nullable
baseMaterialsPricenumberNo format: double
baseTasksPricenumberNo format: double
basePricenumberNo format: double
quantitynumberNo format: double
discountnumberNo format: double
statusstringNo nullable
schedulingPrioritystringNo nullable
schedulingNotesstringNo nullable
leadTimeDaysintegerNo format: int32
leadTimeWeeksnumberNo format: double
attributesarray of LineItemAttrModelNo nullable
tasksarray of LineItemTaskModelNo nullable
itemsarray of LineItemItemAndQtyModelNo nullable
linksarray of DocumentLinkModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
tagsarray of TagModelNo nullable
chargesarray of LineItemChargeModelNo nullable
allowDiscountbooleanNo
lengthUOMstringNo nullable
weightUOMstringNo nullable
showSubTotalstringNo nullable
serializationRequiredstringNo nullable
weightnumberNo format: double
lengthnumberNo format: double
widthnumberNo format: double
heightnumberNo format: double
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
isDeletedbooleanNo
deletedUTCstringNo format: date-time
deletedByUserIDstringNo nullable

Used by: PUT /v1/salesquotes/{SalesQuoteID}/lineitems

LineItemResourceGroupModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
usagenumberNo format: double
LineItemTaskModelobject
PropertyTypeRequiredDetailsDescription
lineItemTaskIDstringNo nullable
workCenterstringNo nullable
namestringNo nullable
detailstringNo nullable
taskNumberintegerNo format: int32
pricingComponentstringNo nullable
timeSetup_minnumberNo format: double
timeTeardown_minnumberNo format: double
timeTransfer_minnumberNo format: double
isTimeBillablebooleanNo
time_MINnumberNo format: double
cost_CURnumberNo format: double
price_CURnumberNo format: double
verificationsarray of LineItemTaskVerificationModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
resourceGroupsarray of LineItemResourceGroupModelNo nullable
informationarray of stringNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
batchRequirementsarray of BatchRequirementModelNo nullable
LineItemTaskVerificationModelobject
PropertyTypeRequiredDetailsDescription
entitystringNo nullable
targetstringNo nullable
targetValuestringNo nullable
hintImageUrlstringNo nullable
helpUrlstringNo nullable
LocationModelobject
PropertyTypeRequiredDetailsDescription
locationIDstringNo nullable
codestringNo nullable
namestringNo nullable
regionstringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
phonestringNo nullable
offsetUTCnumberNo format: double
timeZoneIDstringNo nullable
workDaysarray of WorkDayModelNo nullable
nonWorkingDaysarray of CalendarExceptionModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/locations/{LocationID} PUT /v1/locations

MaintenanceActualModelobject
PropertyTypeRequiredDetailsDescription
actualIDstringNo nullable
planIDstringNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
documentsarray of DocumentModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
MaintenancePlanModelobject
PropertyTypeRequiredDetailsDescription
planIDstringNo nullable
taskIDstringNo nullable
descriptionstringNo nullable
frequencyTypestringNo nullable
frequencyintegerNo format: int32
procedureHoursnumberNo format: double
nextCalendarExceptionIDstringNo nullable
isActivestringNo nullable
actualsarray of MaintenanceActualModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
documentsarray of DocumentModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/maintenance/plans/{PlanID} PUT /v1/maintenance/plans

MessageTypeinteger
NoteModelobject
PropertyTypeRequiredDetailsDescription
noteIDstringNo nullable
notestringNo nullable
byUserIDstringNo nullable
visibilitystringNo nullable
createdUTCstringNo 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
PropertyTypeRequiredDetailsDescription
noteIDstringNo nullable
notestringNo nullable
byUserIDstringNo nullable
visibilitystringNo nullable
createdUTCstringNo format: date-time
parentIDstringNo nullable
NotificationModelobject
PropertyTypeRequiredDetailsDescription
messageIDstringNo nullable
fromstringNo nullable
toUserIDstringNo nullable
messageTypestringNo nullable
subjectstringNo nullable
messagestringNo nullable
urlstringNo nullable
statusstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: PUT /v1/notifications/sendtoall PUT /v1/notifications/sendtorole/{Role} PUT /v1/notifications/sendtouser PUT /v1/salesfunnel/sendtouser

NotificationPreferencesModelobject
PropertyTypeRequiredDetailsDescription
eventsarray of stringNo nullable
OrganizationIncotermModelobject
PropertyTypeRequiredDetailsDescription
termIDstringNo nullable
codestringNo nullable
namestringNo nullable
descriptionstringNo nullable
effectiveYearintegerNo format: int32
locationstringNo nullable
defaultLocationstringNo nullable
isDefaultbooleanNo
notesstringNo nullable
isActivebooleanNo

Used by: PATCH /v1/incoterms/{TermID} POST /v1/incoterms

PackingListModelobject
PropertyTypeRequiredDetailsDescription
packingListIDstringNo nullable
numberstringNo nullable
statusstringNo nullable
listTypestringNo nullable
salesOrderIDstringNo nullable
salesLinesarray of PackingListSalesLineModelNo nullable
salesItemsarray of PackingListSalesItemModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/packinglists/{PackingListID} PUT /v1/packinglists

PackingListSalesItemModelobject
PropertyTypeRequiredDetailsDescription
packingListItemIDstringNo nullable
salesItemAndQtyIDstringNo nullable
quantityToShipintegerNo format: int32
quantityShippedintegerNo format: int32
PackingListSalesLineModelobject
PropertyTypeRequiredDetailsDescription
packingListSalesLineIDstringNo nullable
salesLineItemIDstringNo nullable
quantityToShipnumberNo format: double
quantityShippednumberNo format: double
PaymentSettingsModelobject
PropertyTypeRequiredDetailsDescription
processorstringNo nullable
PersonModelobject
PropertyTypeRequiredDetailsDescription
personIDstringNo nullable
customerIDstringNo nullable
firststringNo nullable
laststringNo nullable
emailAddressstringNo nullable
titlestringNo nullable
urlstringNo nullable
storeIsAuthorizedstringNo nullable
phoneNumbersarray of PhoneNumberModelNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/customers/people/{PersonID} PUT /v1/customers/people

PhaseHistoryModelobject
PropertyTypeRequiredDetailsDescription
phasestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
PhaseModelobject
PropertyTypeRequiredDetailsDescription
phaseIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
statusstringNo nullable
phaseTypestringNo nullable
sortOrderintegerNo format: int32
isDefaultstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/phases/{PhaseID} POST /v1/phases

PhoneNumberModelobject
PropertyTypeRequiredDetailsDescription
numberstringNo nullable
numberTypestringNo nullable
PriceListBreakModelobject
PropertyTypeRequiredDetailsDescription
breakIDstringNo nullable
quantityMinnumberNo format: double
quantityMaxnumberNo format: double
unitPricenumberNo format: double nullable
discountPercentnumberNo format: double nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
PriceListItemModelobject
PropertyTypeRequiredDetailsDescription
listItemIDstringNo nullable
listIDstringNo nullable
itemIDstringNo nullable
basePricenumberNo format: double
breaksarray of PriceListBreakModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/pricelists/{ListID}/items

PriceListModelobject
PropertyTypeRequiredDetailsDescription
listIDstringNo nullable
namestringNo nullable
customerIDstringNo nullable
listTypestringNo nullable
visibilityModestringNo nullable
dateStartstringNo format: date-time
dateEndstringNo format: date-time
defaultBreaksarray of PriceListBreakModelNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/pricelists/{ListID} PUT /v1/pricelists

PricingChangeRequestModelobject
PropertyTypeRequiredDetailsDescription
pricingChangeRequestIDstringNo nullable
instanceIDstringNo nullable
sourceTypestringNo nullable
sourceIDstringNo nullable
lineItemIDstringNo nullable
currentUnitPricenumberNo format: double
proposedUnitPricenumberNo format: double
reasonstringNo nullable
statusstringNo nullable
processIDstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/pricing-change-requests

PricingChangeRequestReceiptobject
PropertyTypeRequiredDetailsDescription
pricingChangeRequestIDstringNo nullable
messagestringNo nullable

Used by: POST /v1/pricing-change-requests

PricingComponentModelobject
PropertyTypeRequiredDetailsDescription
pricingComponentIDstringNo nullable
namestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/pricingcomponents/{PricingComponentID} POST /v1/pricingcomponents

ProblemDetailsobject
PropertyTypeRequiredDetailsDescription
typestringNo nullable
titlestringNo nullable
statusintegerNo format: int32 nullable
detailstringNo nullable
instancestringNo nullable

Used by: DELETE /v1/{ProductID}/rules/all DELETE /v1/approval/policies/{PolicyID} DELETE /v1/attributes/{AttributeID} DELETE /v1/automation/designs/{DesignID} DELETE /v1/automation/designs/{DesignID}/rules/{RuleID} DELETE /v1/automation/runs/{RunID} DELETE /v1/documents/{DocumentID} DELETE /v1/email/{EmailID} DELETE /v1/email/templates/{TemplateID} DELETE /v1/escalation/templates/{TemplateID} DELETE /v1/global/incoterms/{TermID} DELETE /v1/incoterms/{TermID} DELETE /v1/itemmapping/{ItemMappingID} DELETE /v1/itemmapping/{ProductID}/all DELETE /v1/items/{ItemID} DELETE /v1/items/{ItemID}/documents/{DocumentID} DELETE /v1/items/all DELETE /v1/items/compatibility/{CompatibilityID} DELETE /v1/items/reviews/{ReviewID} DELETE /v1/locations/{LocationID} DELETE /v1/maintenance/plans/{PlanID} DELETE /v1/maintenance/plans/{PlanID}/documents/{DocumentID} DELETE /v1/packinglists/{PackingListID} DELETE /v1/pages/{PageID} DELETE /v1/phases/{PhaseID} DELETE /v1/pricelists/{ListID} DELETE /v1/pricingcomponents/{PricingComponentID} DELETE /v1/prodorders/{ProductionOrderID}/images/{ImageID} DELETE /v1/prodorders/escalations/{EscalationID} DELETE /v1/productionorderphases/{PhaseID} DELETE /v1/products/{ProductID} DELETE /v1/products/{ProductID}/documents/{DocumentID} DELETE /v1/products/families/{FamilyID} DELETE /v1/promotions/{PromotionID} DELETE /v1/quality/assets/{AssetID} DELETE /v1/quality/audits/{AuditID} DELETE /v1/quality/capa/{QualityCapaID} DELETE /v1/quality/changes/{ChangeID} DELETE /v1/quality/documents/{DocumentID} DELETE /v1/quality/ncr/{QualityNcrID} DELETE /v1/resourcegroups/{ResourceGroupID} DELETE /v1/resources/{ResourceID} DELETE /v1/rules/{RuleID} DELETE /v1/salesfunnel/{OpportunityID} DELETE /v1/salesquotes/{SalesQuoteID} DELETE /v1/salesquotes/{SalesQuoteID}/documents/{DocumentID} DELETE /v1/salesquotes/{SalesQuoteID}/items/{itemandqtyid} DELETE /v1/salesquotes/{SalesQuoteID}/lineitems/{lineitemid} DELETE /v1/schedule/resequence/requests/{RequestID} DELETE /v1/service/codes/{CodeID} DELETE /v1/service/repairsummary/templates/{TemplateID} DELETE /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} DELETE /v1/suppliers/{SupplierID} DELETE /v1/tasks/{TaskID} DELETE /v1/tenants/{tenantId}/notes/{noteId} DELETE /v1/todo/todo/{ToDoID} DELETE /v1/verticals/{VerticalID} DELETE /v1/webhooks/{WebHookID} DELETE /v1/xml/templates/{TemplateID} GET /v1/announcements/{AnnouncementID} GET /v1/announcements/active GET /v1/approval/policies GET /v1/approval/policies/{PolicyID} GET /v1/attributes GET /v1/attributes/{AttributeID} GET /v1/attributes/{AttributeID}/revisions/history GET /v1/attributes/{ProductID}/export GET /v1/attributes/export GET /v1/attributes/products/{ProductID} GET /v1/attributes/search/{number} GET /v1/audit GET /v1/audit/{AuditID} GET /v1/audit/byid/{EntityID} GET /v1/automation/designs GET /v1/automation/designs/{DesignID} GET /v1/automation/designs/{DesignID}/rules GET /v1/automation/designs/{DesignID}/rules/{RuleID} GET /v1/automation/runs GET /v1/automation/runs/{RunID} GET /v1/automation/runs/count GET /v1/automation/runs/pages/{page} GET /v1/automation/runs/process GET /v1/automation/runs/search/{searchfor} GET /v1/changes/announcements GET /v1/configure/{ProductID}/reset GET /v1/configure/export GET /v1/customers/{CustomerID}/metrics GET /v1/customers/attributes/export GET /v1/customers/count GET /v1/customers/export GET /v1/customers/import/{ImportID}/logs/count GET /v1/customers/import/{ImportID}/logs/pages/{page} GET /v1/customers/import/{ImportID}/summary GET /v1/customers/imports/{ImportID}/logs/count GET /v1/customers/imports/{ImportID}/logs/pages/{page} GET /v1/customers/imports/{ImportID}/summary GET /v1/customers/shipto/export GET /v1/customers/shipto/import/{ImportID}/logs/count GET /v1/customers/shipto/import/{ImportID}/logs/pages/{page} GET /v1/customers/shipto/imports/{ImportID}/logs/count GET /v1/customers/shipto/imports/{ImportID}/logs/pages/{page} GET /v1/customers/shipto/imports/{ImportID}/summary GET /v1/dashboard/escalations GET /v1/delivery GET /v1/delivery/count GET /v1/delivery/options GET /v1/delivery/pages/{page} GET /v1/documents GET /v1/documents/{DocumentID} GET /v1/documents/{DocumentID}/download GET /v1/documents/{DocumentID}/pdf GET /v1/documents/{DocumentID}/references/rules GET /v1/documents/audit/files GET /v1/documents/bytype/{DocumentType} GET /v1/documents/count GET /v1/documents/pages/{page} GET /v1/documents/types/{documenttype}/pages/{page} GET /v1/email GET /v1/email/{EmailID} GET /v1/email/logs GET /v1/email/logs/count GET /v1/email/logs/pages/{page} GET /v1/email/pages/{page} GET /v1/email/search/{searchfor} GET /v1/email/templates GET /v1/email/templates/{TemplateID} GET /v1/email/templates/{TemplateID}/test GET /v1/escalation/templates GET /v1/escalation/templates/{TemplateID} GET /v1/events GET /v1/events/{EventID} GET /v1/events/entities/{EntityID} GET /v1/events/prodorders/invalid-time GET /v1/global/incoterms GET /v1/global/incoterms/{TermID} GET /v1/home/dashboard GET /v1/imports/items/rules GET /v1/imports/jobs/running GET /v1/incoterms GET /v1/incoterms/{TermID} GET /v1/instance/invoices/{InvoiceID}/pdf GET /v1/instances/{InstanceID}/integrations GET /v1/instances/{InstanceID}/integrations/{IntegrationID} GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID} GET /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/released GET /v1/instances/configurationhistory GET /v1/invoices/{InvoiceID}/pdf GET /v1/itemmapping/{ItemMappingID}/detail GET /v1/itemmapping/{ProductID} GET /v1/itemmapping/{ProductID}/categories GET /v1/itemmapping/{ProductID}/count GET /v1/itemmapping/{ProductID}/export GET /v1/itemmapping/{ProductID}/match/{AttributesAndValues} GET /v1/itemmapping/{ProductID}/pages/{Page} GET /v1/itemmapping/{ProductID}/search/{SearchFor} GET /v1/itemmapping/{ProductID}/validate GET /v1/itemmapping/products/{ProductID}/categories GET /v1/itemmapping/products/{ProductID}/export GET /v1/items GET /v1/items/{ItemID} GET /v1/items/{ItemID}/compatibility GET /v1/items/{ItemID}/documents/{DocumentID} GET /v1/items/{ItemID}/references GET /v1/items/{itemID}/store GET /v1/items/attribute-definitions GET /v1/items/attribute-definitions/proposals GET /v1/items/attributes/summary GET /v1/items/attributes/withvalues GET /v1/items/bynumber/{Number} GET /v1/items/categories GET /v1/items/compatibility GET /v1/items/compatibility/{CompatibilityID} GET /v1/items/compatibility/effective GET /v1/items/compatibility/search GET /v1/items/contractpricing GET /v1/items/count GET /v1/items/countries GET /v1/items/export GET /v1/items/import/{ImportID}/logs/count GET /v1/items/import/{ImportID}/logs/pages/{page} GET /v1/items/import/summary GET /v1/items/pages/{page} GET /v1/items/promotions GET /v1/items/recent GET /v1/items/reviews GET /v1/items/reviews/{ReviewID} GET /v1/items/reviews/{ReviewID}/references GET /v1/items/search/{q} GET /v1/localization GET /v1/locations GET /v1/locations/{LocationID} GET /v1/locations/{LocationID}/nonworkingdays/export GET /v1/locations/export GET /v1/locations/imports/{ImportID}/logs/count GET /v1/locations/imports/{ImportID}/logs/pages/{page} GET /v1/locations/imports/{ImportID}/summary GET /v1/locations/nonworkingdays/export GET /v1/maintenance/plans GET /v1/maintenance/plans/{PlanID} GET /v1/maintenance/plans/{PlanID}/documents/{DocumentID} GET /v1/maintenance/plans/count GET /v1/maintenance/plans/pages/{page} GET /v1/notes/prodorders GET /v1/notes/prodordertasks GET /v1/notes/salesorders GET /v1/notes/salesquotes GET /v1/packinglists GET /v1/packinglists/{PackingListID} GET /v1/packinglists/{PackingListID}/pdf GET /v1/pages/{PageID} GET /v1/pages/{PageID}/attributes/renumber GET /v1/pages/{PageID}/attributes/renumber/alpha GET /v1/pages/products/{ProductID} GET /v1/pages/products/{ProductID}/count GET /v1/phases GET /v1/phases/{PhaseID} GET /v1/pricelists GET /v1/pricelists/{ListID} GET /v1/pricelists/{ListID}/items GET /v1/pricingcomponents GET /v1/pricingcomponents/{PricingComponentID} GET /v1/pricingcomponents/{PricingComponentID}/references/items GET /v1/pricingcomponents/{PricingComponentID}/references/tasks GET /v1/prodorders/{ProductionOrderID}/escalations GET /v1/prodorders/{ProductionOrderID}/events GET /v1/prodorders/{ProductionOrderID}/images GET /v1/prodorders/{ProductionOrderID}/images/{ImageID} GET /v1/prodorders/{ProductionOrderID}/images/{ImageID}/download GET /v1/prodorders/{ProductionOrderID}/resequence/request GET /v1/prodorders/escalations GET /v1/prodorders/escalations/{EscalationID} GET /v1/prodorders/escalations/active GET /v1/prodorders/escalations/count GET /v1/prodorders/events GET /v1/prodorders/events/bootstrap GET /v1/prodorders/events/filters GET /v1/prodorders/events/pages/{page} GET /v1/prodorders/events/prodorders GET /v1/prodorders/events/products GET /v1/prodorders/events/salesorders GET /v1/prodorders/events/users GET /v1/prodorders/events/users/{UserID}/clockedin GET /v1/prodorders/tasks/{TaskName}/events GET /v1/prodorders/tasks/{TaskName}/events/count GET /v1/prodorders/tasks/{TaskName}/events/pages/{page} GET /v1/productionorderphases GET /v1/productionorderphases/{PhaseID} GET /v1/products GET /v1/products/{ProductID} GET /v1/products/{ProductID}/attributes GET /v1/products/{ProductID}/attributes/count GET /v1/products/{ProductID}/attributes/export GET /v1/products/{ProductID}/documents/{DocumentID} GET /v1/products/{ProductID}/image GET /v1/products/{ProductID}/images GET /v1/products/{ProductID}/itemmapping GET /v1/products/{ProductID}/itemmapping/count GET /v1/products/{ProductID}/itemmapping/match/{AttributesAndValues} GET /v1/products/{ProductID}/itemmapping/pages/{Page} GET /v1/products/{ProductID}/itemmapping/search/{SearchFor} GET /v1/products/{ProductID}/itemmapping/validate GET /v1/products/{ProductID}/items GET /v1/products/{ProductID}/pages GET /v1/products/{ProductID}/pages/count GET /v1/products/{ProductID}/references/build GET /v1/products/{ProductID}/references/items GET /v1/products/{ProductID}/rules GET /v1/products/{ProductID}/rules/export GET /v1/products/{ProductID}/snapshots GET /v1/products/{ProductID}/snapshots/{SnapshotID} GET /v1/products/{ProductID}/validate GET /v1/products/families GET /v1/products/families/{FamilyID} GET /v1/products/families/alphabetize GET /v1/products/families/renumber GET /v1/products/search/{number} GET /v1/products/validate GET /v1/promotions GET /v1/promotions/{PromotionID} GET /v1/promotions/{PromotionID}/salesquote/add GET /v1/provisioning/tenants/{tenantId} GET /v1/quality/assets GET /v1/quality/assets/{AssetID} GET /v1/quality/assets/count GET /v1/quality/assets/export GET /v1/quality/assets/import/results GET /v1/quality/assets/pages/{page} GET /v1/quality/assets/search/{search} GET /v1/quality/audits GET /v1/quality/audits/{AuditID} GET /v1/quality/capa GET /v1/quality/capa/{QualityCapaID} GET /v1/quality/changes GET /v1/quality/changes/{ChangeID} GET /v1/quality/documents GET /v1/quality/documents/{DocumentID} GET /v1/quality/documents/{DocumentID}/download GET /v1/quality/documents/count GET /v1/quality/documents/export GET /v1/quality/documents/pages/{page} GET /v1/quality/ncr GET /v1/quality/ncr/{QualityNcrID} GET /v1/quality/ncr/search/{search} GET /v1/quality/ncr/status/{status} GET /v1/releasenotes GET /v1/releasenotes/{date} GET /v1/reports/{Report} GET /v1/resourcegroups GET /v1/resourcegroups/{ResourceGroupID} GET /v1/resourcegroups/byname/{ResourceGroupName} GET /v1/resources GET /v1/resources/{ResourceID} GET /v1/resources/byname/{ResourceName} GET /v1/rules GET /v1/rules/{ProductID}/export GET /v1/rules/{RuleID} GET /v1/rules/export GET /v1/rules/products/{ProductID} GET /v1/rules/products/{ProductID}/count GET /v1/rules/products/{ProductID}/groups/{RuleGroupID} GET /v1/rules/search/{number} GET /v1/salesfunnel GET /v1/salesfunnel/{OpportunityID} GET /v1/salesfunnel/count GET /v1/salesfunnel/export GET /v1/salesfunnel/pages/{page} GET /v1/salesfunnel/people GET /v1/salesfunnel/search/{SearchString} GET /v1/salesfunnel/totals GET /v1/salesquotes GET /v1/salesquotes/{SalesQuoteID} GET /v1/salesquotes/{SalesQuoteID}/cancel GET /v1/salesquotes/{SalesQuoteID}/documents/{DocumentID} GET /v1/salesquotes/{SalesQuoteID}/items/{ItemID}/pricing GET /v1/salesquotes/{SalesQuoteID}/lineitems/{LineItemID}/export/bom GET /v1/salesquotes/{SalesQuoteID}/lineitems/{LineItemID}/export/router GET /v1/salesquotes/{salesQuoteId}/margin-approvals GET /v1/salesquotes/{SalesQuoteID}/pdf GET /v1/salesquotes/{SalesQuoteID}/pdf/validate GET /v1/salesquotes/{SalesQuoteID}/public/url GET /v1/salesquotes/{SalesQuoteID}/simulations GET /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} GET /v1/salesquotes/bycustomer/{CustomerID} GET /v1/salesquotes/bysalesorder/{SalesOrderID} GET /v1/salesquotes/count GET /v1/salesquotes/createdby/{UserID} GET /v1/salesquotes/customers GET /v1/salesquotes/export/lineitems GET /v1/salesquotes/export/summary GET /v1/salesquotes/logs/email GET /v1/salesquotes/logs/email/{LogID} GET /v1/salesquotes/mtd GET /v1/salesquotes/notinfunnel GET /v1/salesquotes/public/checkout GET /v1/salesquotes/public/validate GET /v1/salesquotes/search/{quotenumber} GET /v1/salesquotes/statemachines/payment GET /v1/salesquotes/statemachines/status GET /v1/salesquotes/ytd GET /v1/schedule/build GET /v1/schedule/queues/search/{searchfor} GET /v1/schedule/resequence/requests GET /v1/schedule/resequence/requests/{RequestID} GET /v1/schedule/results/last/count GET /v1/schedule/results/last/pages/{page} GET /v1/serialization/export GET /v1/serialization/import/results GET /v1/service/codes GET /v1/service/codes/{CodeID} GET /v1/service/codes/products/{ProductID} GET /v1/service/repairsummary/templates GET /v1/service/repairsummary/templates/{TemplateID} GET /v1/service/tickets/export GET /v1/service/tickets/import/results GET /v1/service/tickets/search/{q} GET /v1/service/troublereports/{ReportID}/pdf GET /v1/service/troublereports/{ReportID}/pdf/validate GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} GET /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}/download GET /v1/setup/countries GET /v1/setup/countries/{CountryID} GET /v1/setup/countries/{CountryID}/subdivisions GET /v1/setup/countries/codes/{code} GET /v1/setup/currencies GET /v1/setup/currencies/{CurrencyID} GET /v1/setup/currencies/{CurrencyID}/fx GET /v1/setup/currencies/codes/{code} GET /v1/setup/currencies/codes/{code}/fx GET /v1/setup/currencies/fx GET /v1/setup/states GET /v1/setup/timezones GET /v1/suppliers GET /v1/suppliers/{SupplierID} GET /v1/suppliers/ByNumber/{SupplierNumber} GET /v1/suppliers/count GET /v1/suppliers/export GET /v1/suppliers/import/results GET /v1/suppliers/pages/{page} GET /v1/suppliers/search/{SearchString} GET /v1/tasks GET /v1/tasks/{TaskID} GET /v1/tasks/{TaskID}/references/rules GET /v1/tasks/byname/{TaskName} GET /v1/tasks/export GET /v1/tasks/numbers/next GET /v1/tasks/renumber GET /v1/tasks/search/{number} GET /v1/tenant-provisioning/{tenantId} GET /v1/tenants/{tenantId}/notes GET /v1/tenants/{tenantId}/notes/{noteId} GET /v1/todo GET /v1/todo/{ToDoID} GET /v1/todo/export GET /v1/todo/products/{ProductID} GET /v1/todo/roles/{role} GET /v1/todo/salesorders/{SalesOrderID} GET /v1/todo/salesquotes/{SalesQuoteID} GET /v1/tours/{TourID} GET /v1/verticals GET /v1/verticals/{VerticalID} GET /v1/webhooks GET /v1/webhooks/{WebhookID} GET /v1/webhooks/log GET /v1/webhooks/logs/count GET /v1/webhooks/logs/pages/{page} GET /v1/xml/templates GET /v1/xml/templates/{TemplateID} PATCH /v1/approval/policies/{PolicyID} PATCH /v1/attributes/{AttributeID} PATCH /v1/attributes/{AttributeID}/query PATCH /v1/attributes/batch PATCH /v1/automation/designs/{DesignID} PATCH /v1/automation/designs/{DesignID}/rules/{RuleID} PATCH /v1/automation/runs/{RunID} PATCH /v1/customers/{CustomerID}/shipto/{ShipToID} PATCH /v1/documents/{DocumentID} PATCH /v1/documents/{DocumentID}/replace PATCH /v1/email/templates/{TemplateID} PATCH /v1/escalation/templates/{TemplateID} PATCH /v1/global/incoterms/{TermID} PATCH /v1/incoterms/{TermID} PATCH /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID}/state PATCH /v1/instances/{InstanceID}/type PATCH /v1/instances/gbb-catalog PATCH /v1/itemmapping PATCH /v1/itemmapping/{ItemMappingID}/history 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/{itemID}/store PATCH /v1/items/batch PATCH /v1/items/reviews/{ReviewID}/basics PATCH /v1/locations/{LocationID} PATCH /v1/maintenance/plans/{PlanID} PATCH /v1/packinglists/{PackingListID} PATCH /v1/pages/{PageID} PATCH /v1/phases/{PhaseID} PATCH /v1/pricelists/{ListID} PATCH /v1/pricingcomponents/{PricingComponentID} PATCH /v1/prodorders/{ProductionOrderID}/images/{ImageID} PATCH /v1/prodorders/escalations/{EscalationID} PATCH /v1/productionorderphases/{PhaseID} PATCH /v1/products/{ProductID} PATCH /v1/products/{ProductID}/attributes/pricing/reset PATCH /v1/products/{ProductID}/image PATCH /v1/products/{ProductID}/images PATCH /v1/products/{ProductID}/Links PATCH /v1/products/{ProductID}/notes PATCH /v1/products/{ProductID}/snapshots/{SnapshotID} PATCH /v1/products/{ProductID}/store PATCH /v1/products/{ProductID}/tags PATCH /v1/products/families/{FamilyID} PATCH /v1/promotions/{PromotionID} PATCH /v1/quality/assets/{AssetID} PATCH /v1/quality/assets/{AssetID}/Notes PATCH /v1/quality/audits/{AuditID} PATCH /v1/quality/audits/{AuditID}/findings PATCH /v1/quality/audits/{AuditID}/notes PATCH /v1/quality/capa/{QualityCapaID} PATCH /v1/quality/capa/{QualityCapaID}/Phases/{Phase}/Notes PATCH /v1/quality/changes/{ChangeID} PATCH /v1/quality/changes/{ChangeID}/Notes PATCH /v1/quality/documents/{DocumentID} PATCH /v1/quality/documents/{DocumentID}/notes PATCH /v1/quality/ncr/{QualityNcrID} PATCH /v1/quality/ncr/{QualityNcrID}/Assignment PATCH /v1/quality/ncr/{QualityNcrID}/Notes PATCH /v1/resourcegroups/{ResourceGroupID} PATCH /v1/resourcegroups/{ResourceGroupID}/notes PATCH /v1/resources/{ResourceID} PATCH /v1/resources/{ResourceID}/nonworkingdays PATCH /v1/resources/{ResourceID}/notes PATCH /v1/rules/{RuleID} PATCH /v1/salesfunnel/{OpportunityID} PATCH /v1/salesfunnel/{OpportunityID}/notes PATCH /v1/salesfunnel/{OpportunityID}/people PATCH /v1/salesfunnel/{OpportunityID}/tags PATCH /v1/salesquotes/{SalesQuoteID}/basics PATCH /v1/salesquotes/{SalesQuoteID}/customer PATCH /v1/salesquotes/{SalesQuoteID}/delivery/update/{DeliveryOptionID} 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}/phase PATCH /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} PATCH /v1/salesquotes/{SalesQuoteID}/status PATCH /v1/salesquotes/{SalesQuoteID}/status/historical PATCH /v1/salesquotes/{SalesQuoteID}/tags PATCH /v1/salesquotes/{SalesQuoteID}/validity PATCH /v1/salesquotes/createdby PATCH /v1/schedule/resequence/requests/{RequestID} PATCH /v1/service/codes/{CodeID} PATCH /v1/service/repairsummary/templates/{TemplateID} PATCH /v1/service/reports/createdby PATCH /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID} PATCH /v1/suppliers/{SupplierID}/basics PATCH /v1/suppliers/{SupplierID}/notes PATCH /v1/suppliers/{SupplierID}/people PATCH /v1/tasks/{TaskID} PATCH /v1/tasks/{TaskID}/invitations PATCH /v1/tasks/{TaskID}/model/cost PATCH /v1/tasks/{TaskID}/model/time PATCH /v1/tasks/{TaskID}/nesting PATCH /v1/tasks/{TaskID}/nonworkingdays PATCH /v1/todo PATCH /v1/tours/{TourID} PATCH /v1/webhooks/{WebHookID} PATCH /v1/xml/templates/{TemplateID} POST /v1/{ProductID}/attributes/{AttributeID}/requestvalue POST /v1/announcements POST /v1/approval/policies POST /v1/attributes/{AttributeID}/queries/test POST /v1/attributes/by/productids POST /v1/audit POST /v1/audit/count POST /v1/audit/pages/{page} POST /v1/audit/prodorders/phase POST /v1/audit/prodorders/status POST /v1/audit/salesorders/status POST /v1/audit/salesquotes/phase POST /v1/audit/salesquotes/status POST /v1/automation/designs POST /v1/automation/designs/{DesignID}/rules POST /v1/automation/runs POST /v1/configure/{ProductID}/configuration POST /v1/configure/{ProductID}/configuration/selection POST /v1/customers/{CustomerID}/copyinto POST /v1/customers/attributes/import POST /v1/customers/count POST /v1/customers/records/import POST /v1/customers/shipto/import POST /v1/documents POST /v1/email/templates POST /v1/escalation/templates POST /v1/events/count POST /v1/events/pages/{page} POST /v1/events/prodorders/export POST /v1/global/incoterms POST /v1/global/incoterms/{TermID}/copy-to-tenant POST /v1/imports/{ImportID}/reset POST /v1/incoterms POST /v1/instances/{InstanceID}/smartquote/{ProductID}/versions POST /v1/itemmapping/{ProductID}/import POST /v1/items/{ItemID}/copyinto POST /v1/items/{ItemID}/costandpricecheck POST /v1/items/{ItemID}/documents POST /v1/items/analysis/costandprice POST /v1/items/byids POST /v1/items/compatibility POST /v1/items/compatibility/{CompatibilityID}/review POST /v1/items/count POST /v1/items/import POST /v1/items/pages/{page} POST /v1/items/product-finder POST /v1/locations/{LocationID}/nonworkingdays/import POST /v1/locations/import POST /v1/locations/nonworkingdays/import POST /v1/maintenance/plans/{PlanID}/documents POST /v1/phases POST /v1/pricelists/{ListID}/items POST /v1/pricing-change-requests POST /v1/pricingcomponents POST /v1/process-events POST /v1/prodorders/{ProductionOrderID}/images POST /v1/prodorders/{ProductionOrderID}/images/{ImageID}/replace POST /v1/prodorders/escalations POST /v1/prodorders/escalations/pages/{page} 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} POST /v1/product-change-requests POST /v1/productionorderphases POST /v1/products/{productID}/ai/apply POST /v1/products/{ProductID}/attributes/{AttributeID}/feedback/request POST /v1/products/{ProductID}/copyinto POST /v1/products/{ProductID}/documents POST /v1/products/{ProductID}/Duplicate POST /v1/products/{ProductID}/itemmapping/import POST /v1/products/families POST /v1/promotions POST /v1/provisioning/tenants POST /v1/provisioning/tenants/{tenantId}/seed-runs POST /v1/quality/assets POST /v1/quality/assets/import POST /v1/quality/audits POST /v1/quality/capa POST /v1/quality/changes POST /v1/quality/documents/add POST /v1/quality/ncr POST /v1/salesquotes POST /v1/salesquotes/{SalesQuoteID}/documents POST /v1/salesquotes/{SalesQuoteID}/email/checkout POST /v1/salesquotes/{SalesQuoteID}/email/link POST /v1/salesquotes/{SalesQuoteID}/email/pdf POST /v1/salesquotes/{SalesQuoteID}/payment/cc POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/approve POST /v1/salesquotes/{SalesQuoteID}/payment/test/{Outcome} POST /v1/salesquotes/{SalesQuoteID}/simulations POST /v1/salesquotes/analysis/createdby POST /v1/salesquotes/analysis/createdon POST /v1/salesquotes/analysis/customers POST /v1/salesquotes/analysis/lines POST /v1/salesquotes/analysis/phase POST /v1/salesquotes/analysis/status POST /v1/salesquotes/byids POST /v1/salesquotes/count POST /v1/salesquotes/export/lineitems POST /v1/salesquotes/export/summary POST /v1/salesquotes/import POST /v1/salesquotes/index/pages/{page} POST /v1/salesquotes/pages/{page} POST /v1/salesquotes/pages/{page}/customers POST /v1/salesquotes/recent POST /v1/schedule/export POST /v1/schedule/queues/export POST /v1/schedule/queues/utilization/export POST /v1/schedule/resequence/requests POST /v1/schedule/resequence/requests/all POST /v1/schedule/resequence/requests/count POST /v1/schedule/resequence/requests/create POST /v1/schedule/resequence/requests/pages/{page} POST /v1/search POST /v1/serialization/import POST /v1/service/codes POST /v1/service/repairsummary/templates POST /v1/service/tickets/import POST /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images POST /v1/service/troublereports/{ReportID}/symptoms/{SymptomID}/images/{ImageID}/replace POST /v1/suppliers/import POST /v1/tasks/copyto/{TargetInstanceID} POST /v1/tasks/import POST /v1/tenant-provisioning POST /v1/tenants/{tenantId}/notes POST /v1/tenants/{tenantId}/seed-runs POST /v1/webhooks POST /v1/webhooks/{WebhookID}/diagnose POST /v1/webhooks/logs POST /v1/webhooks/logs/count POST /v1/webhooks/logs/pages POST /v1/xml/templates PUT /v1/attributes PUT /v1/attributes/batch PUT /v1/configure/{ProductID}/promotion/create PUT /v1/configure/{ProductID}/salesorders/{SalesOrderID} PUT /v1/configure/{ProductID}/salesquotes/{SalesQuoteID} PUT /v1/email PUT /v1/instances/{InstanceID}/integrations/{IntegrationID}/execute PUT /v1/itemmapping PUT /v1/items PUT /v1/items/{ItemID}/review PUT /v1/items/batch PUT /v1/items/compatibility/{CompatibilityID} PUT /v1/items/reviews PUT /v1/locations PUT /v1/maintenance/plans PUT /v1/packinglists PUT /v1/pages PUT /v1/pages/batch PUT /v1/pricelists PUT /v1/prodorders/escalations PUT /v1/products PUT /v1/products/{ProductID}/snapshots PUT /v1/resourcegroups PUT /v1/resources PUT /v1/rules PUT /v1/rules/batch PUT /v1/salesfunnel PUT /v1/salesfunnel/{OpportunityID}/notes PUT /v1/salesquotes PUT /v1/salesquotes/{SalesQuoteID}/items PUT /v1/salesquotes/{SalesQuoteID}/lineitems PUT /v1/salesquotes/{SalesQuoteID}/notes PUT /v1/salesquotes/logs/email PUT /v1/suppliers PUT /v1/tasks PUT /v1/tenants/{tenantId}/notes/{noteId} PUT /v1/todo PUT /v1/verticals/{VerticalID}

ProcessEventModelobject
PropertyTypeRequiredDetailsDescription
eventIdstringNo nullable
eventTypestringNo nullable
occurredUtcstringNo format: date-time
processIdstringNo nullable
definitionIdstringNo nullable
transitionIdstringNo nullable
approvalOutcomestringNo nullable
fromStatestringNo nullable
toStatestringNo nullable
entityTypestringNo nullable
entityIdstringNo nullable
actorUserIdstringNo nullable
lineIdstringNo nullable
lineRevisionstringNo nullable
calculationSnapshotIdstringNo nullable
calculatorIdstringNo nullable
calculatorVersionstringNo nullable
kaiMarginPercentnumberNo format: double nullable
globalMarginPercentnumberNo format: double nullable
sisterCompanyMarginPercentnumberNo format: double nullable
policyTargetPercentnumberNo format: double nullable
policySourcestringNo nullable

Used by: POST /v1/process-events

ProductAiApplyRequestModelobject
PropertyTypeRequiredDetailsDescription
pagesarray of DefinitionPageModelNo nullable
attributesarray of DefinitionAttributeModelNo nullable
ruleGroupsarray of DefinitionRuleGroupModelNo nullable
rulesarray of DefinitionRuleModelNo nullable

Used by: POST /v1/products/{productID}/ai/apply

ProductChangeRequestModelobject
PropertyTypeRequiredDetailsDescription
productChangeRequestIDstringNo nullable
instanceIDstringNo nullable
productIDstringNo nullable
attributeIDstringNo nullable
itemIDstringNo nullable
requestTypestringNo nullable
messagestringNo nullable
sourceUrlstringNo nullable
configurationSnapshotJsonstringNo nullable
processTemplateKeystringNo nullable
processIDstringNo nullable
statusstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/product-change-requests

ProductChangeRequestReceiptobject
PropertyTypeRequiredDetailsDescription
productChangeRequestIDstringNo nullable
processIDstringNo nullable
messagestringNo nullable
createdbooleanNo

Used by: POST /v1/product-change-requests

ProductFamilyModelobject
PropertyTypeRequiredDetailsDescription
familyIDstringNo nullable
namestringNo nullable
sortOrderintegerNo format: int32
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/products/families/{FamilyID} POST /v1/products/families

ProductFinderQueryModelobject
PropertyTypeRequiredDetailsDescription
compatibilitySessionIDstringNo nullable
categorystringNo nullable
facetSearchstringNo nullable
filtersarray of FilterConditionModelNo nullable
pageintegerNo format: int32
pageSizeintegerNo format: int32
relationshipContextarray of KnowledgeRelationshipSubjectModelNo nullable
relationshipApplicabilityItemRelationshipApplicabilityModelNo

Used by: POST /v1/items/product-finder

ProductImageModelobject
PropertyTypeRequiredDetailsDescription
imageIDstringNo nullable
imageBase64stringNo nullable
sortOrderintegerNo format: int32
createdUTCstringNo format: date-time
ProductionEventsSlicerModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
productIDstringNo nullable
taskNamestringNo nullable
familyIDstringNo nullable
customerIDstringNo nullable
fromDatestringNo format: date-time nullable
toDatestringNo format: date-time nullable
yearintegerNo format: int32
monthintegerNo 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
PropertyTypeRequiredDetailsDescription
productionOrderIDstringNo nullable
customerIDstringNo nullable
dateMinstringNo format: date-time
dateMaxstringNo format: date-time

Used by: POST /v1/audit/prodorders/phase POST /v1/audit/prodorders/status

ProductionOrderBatchContentModelobject
PropertyTypeRequiredDetailsDescription
productionOrderIDstringNo nullable
productionOrderTaskIDstringNo nullable
ProductionOrderBatchModelobject
PropertyTypeRequiredDetailsDescription
batchIDstringNo nullable
namestringNo nullable
taskNamestringNo nullable
groupByAttributestringNo nullable
contentarray of ProductionOrderBatchContentModelNo nullable
statusstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/prodorders/batches/{BatchID} PUT /v1/prodorders/batches

ProductionOrderCancelModelobject
PropertyTypeRequiredDetailsDescription
itemAndQtyIDsarray of stringNo nullable
noteNoteModelNo

Used by: POST /v1/prodorders/{ProductionOrderID}/cancel

ProductionOrderEscalationModelobject
PropertyTypeRequiredDetailsDescription
escalationIDstringNo nullable
userIDstringNo nullable
productionOrderIDstringNo nullable
messagestringNo nullable
statusstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
closedUTCstringNo format: date-time nullable
documentsarray of DocumentModelNo nullable

Used by: PATCH /v1/prodorders/escalations/{EscalationID}

ProductionOrderEscalationPostModelobject
PropertyTypeRequiredDetailsDescription
escalationIDstringNo nullable
userIDstringNo nullable
productionOrderIDstringNo nullable
messagestringNo nullable
statusstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
closedUTCstringNo format: date-time nullable
documentsarray of DocumentUploadModelNo nullable

Used by: PUT /v1/prodorders/escalations

ProductionOrderEscalationSlicerModelobject
PropertyTypeRequiredDetailsDescription
createdByUserIDstringNo nullable
statusstringNo nullable
customerIDstringNo nullable
createdUTCYearintegerNo format: int32
createdUTCMonthintegerNo format: int32

Used by: POST /v1/prodorders/escalations POST /v1/prodorders/escalations/pages/{page}

ProductionOrderEventsByMonthModelobject
PropertyTypeRequiredDetailsDescription
monthsarray of ProductionOrderEventsByMonthPointModelNo nullable
totalEventsintegerNo format: int32

Used by: POST /v1/prodorders/events/analysis/month

ProductionOrderEventsByMonthPointModelobject
PropertyTypeRequiredDetailsDescription
monthUTCstringNo format: date-time
eventCountintegerNo format: int32
totalMinutesnumberNo format: double
activeUsersintegerNo format: int32
ProductionOrderMaterialsRequestModelobject
PropertyTypeRequiredDetailsDescription
requestIDstringNo nullable
productionOrderIDstringNo nullable
statusstringNo nullable
itemsarray of LineItemItemAndQtyModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
ProductionOrderMaterialsUpdateModelobject
PropertyTypeRequiredDetailsDescription
submissionIDstringNo nullable
requestProductionOrderMaterialsRequestModelNo

Used by: PATCH /v1/schedule/materials/{RequestID}

ProductionOrderModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
productionOrderIDstringNo nullable
numberstringNo nullable
productionOrderNumberstringNo nullable
parentProductionOrderIDstringNo nullable
statusintegerNo format: int32
statusTextstringNo nullable
sequenceNumberintegerNo format: int32
salesOrderIDstringNo nullable
salesOrderLineItemIDstringNo nullable
serviceTicketIDstringNo nullable
serviceTicketLineItemIDstringNo nullable
phasestringNo nullable
quantitynumberNo format: double
serializationRequiredstringNo nullable
schedulingPrioritystringNo nullable
schedulingNotesstringNo nullable
plannedStartUTCstringNo format: date-time
plannedCompletionUTCstringNo format: date-time
tasksarray of ProductionOrderTaskModelNo nullable
itemsarray of LineItemItemAndQtyModelNo nullable
lenXintegerNo format: int32
widthYintegerNo format: int32
heightZintegerNo format: int32
touchTimenumberNo format: double
waitTimenumberNo format: double
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
tagsarray of TagModelNo nullable
documentsarray of DocumentModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
serialNumbersarray of ItemSerializationModelNo nullable
lotNumbersarray of ItemTraceabilityModelNo nullable
phaseHistoryarray of PhaseHistoryModelNo nullable
assignedResourceIDstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
phaseIDstringNo nullable
namestringNo nullable
statusstringNo nullable
phaseTypestringNo nullable
sortOrderintegerNo format: int32
delayDaysintegerNo format: int32
isDefaultstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/productionorderphases/{PhaseID} POST /v1/productionorderphases

ProductionOrderResourceGroupModelobject
PropertyTypeRequiredDetailsDescription
resourceGroupIDstringNo nullable
defResourceGroupIDstringNo nullable
namestringNo nullable
usagenumberNo format: double
ProductionOrderResourceModelobject
PropertyTypeRequiredDetailsDescription
resourceIDstringNo nullable
defResourceIDstringNo nullable
namestringNo nullable
acknowledgementUTCstringNo format: date-time
acknowledgedByUserIDstringNo nullable
usagenumberNo format: double
ProductionOrderSlicerModelobject
PropertyTypeRequiredDetailsDescription
assignedToResourceIDstringNo nullable
statusintegerNo format: int32
limitintegerNo format: int32
tagValuestringNo nullable
tagLabelstringNo nullable
daysElapsedintegerNo format: int32
daysElapsedEndintegerNo format: int32
percentCompleteintegerNo format: int32
customerIDstringNo nullable
phaseStringFilterNo
iDsarray of stringNo 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
PropertyTypeRequiredDetailsDescription
productionOrderTaskIDstringNo nullable
productionOrderIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
numberintegerNo format: int32
statusstringNo nullable
planMinutesnumberNo format: double
timeSetup_minnumberNo format: double
timeTeardown_minnumberNo format: double
timeTransfer_minnumberNo format: double
minMaxWaitDelta_minnumberNo format: double
plannedStartUTCstringNo format: date-time
plannedFinishUTCstringNo format: date-time
actualStartUTCstringNo format: date-time
actualFinishUTCstringNo format: date-time
verificationsarray of ProductionOrderTaskVerificationModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
resourcesarray of ProductionOrderResourceModelNo nullable
resourceGroupsarray of ProductionOrderResourceGroupModelNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
ProductionOrderTaskStatusUpdateRequestobject
PropertyTypeRequiredDetailsDescription
newStatusstringNo nullable
forceAdminOverridebooleanNo

Used by: POST /v1/prodorders/{ProductionOrderID}/tasks/{ProductionOrderTaskID}/status

ProductionOrderTaskVerificationModelobject
PropertyTypeRequiredDetailsDescription
entitystringNo nullable
targetstringNo nullable
targetValuestringNo nullable
hintImageUrlstringNo nullable
helpUrlstringNo nullable
isVerifiedstringNo nullable
ProductionQueueModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
locationIDstringNo nullable
workCenterstringNo nullable
capacityTaskCapacityModelNo
tasksarray of ProductionOrderTaskModelNo nullable
hoursAvailablenumberNo format: double
ProductionTimeLedgerAuditRowModelobject
PropertyTypeRequiredDetailsDescription
eventIDstringNo nullable
productionOrderIDstringNo nullable
productionOrderTaskIDstringNo nullable
userIDstringNo nullable
taskNamestringNo nullable
taskNumberintegerNo format: int32
statusstringNo nullable
clockInUTCstringNo format: date-time
clockOutUTCstringNo format: date-time
durationMinutesnumberNo format: double nullable
qualityStatusstringNo nullable
detailstringNo nullable

Used by: GET /v1/events/prodorders/invalid-time

ProductMaintainerModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
ProductModelobject
PropertyTypeRequiredDetailsDescription
productIDstringNo nullable
namestringNo nullable
productNamestringNo nullable
versionLabelstringNo nullable
workInstructionIDstringNo nullable
workInstructionRevisionIDstringNo nullable
familyIDstringNo nullable
showSmartQuoteProdOrderstringNo nullable
diagnosticTreeIDstringNo nullable
serializationRequiredstringNo nullable
allowSalesQuotesstringNo nullable
allowSalesOrdersstringNo nullable
allowTroubleReportsstringNo nullable
showPriceSummarystringNo nullable
storeVisiblestringNo nullable
storeShowPricingstringNo nullable
restrictToCustomerIDsarray of stringNo nullable
imageBase64stringNo nullable
imagesarray of ProductImageModelNo nullable
warrantyDaysintegerNo format: int32
standardLeadTimeDaysintegerNo format: int32
maxDaysAllowedintegerNo format: int32
isActivestringNo nullable
documentsarray of DocumentModelNo nullable
linksarray of DocumentLinkModelNo nullable
pricingComponentsarray of stringNo nullable
priceRoundingRoundingOptionNo
tagsarray of TagModelNo nullable
gbbDesignSetsarray of GbbDesignSetModelNo nullable
notesarray of NoteModelNo nullable
maintainersarray of ProductMaintainerModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
requestIDstringNo nullable
deletedPagesintegerNo format: int32
deletedAttributesintegerNo format: int32
deletedRuleGroupsintegerNo format: int32
deletedRulesintegerNo format: int32
createdPagesintegerNo format: int32
createdAttributesintegerNo format: int32
createdRuleGroupsintegerNo format: int32
createdRulesintegerNo format: int32
deletedEventsintegerNo format: int32
createdEventsintegerNo format: int32
elapsedMsintegerNo format: int64

Used by: POST /v1/products/{productID}/ai/apply

ProductSnapshotModelobject
PropertyTypeRequiredDetailsDescription
snapshotIDstringNo nullable
productIDstringNo nullable
statusstringNo nullable
focusstringNo nullable
descriptionstringNo nullable
attributesarray of LineItemAttrModelNo nullable
tasksarray of ProductSnapshotTaskModelNo nullable
pagesarray of DefinitionPageModelNo nullable
rulesarray of DefinitionRuleModelNo nullable
commentsstringNo nullable
sendToUserIDstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/products/{ProductID}/snapshots/{SnapshotID} PUT /v1/products/{ProductID}/snapshots

ProductSnapshotTaskModelobject
PropertyTypeRequiredDetailsDescription
taskLineItemTaskModelNo
newPositionstringNo nullable
newProcessstringNo nullable
newTimestringNo nullable
excludestringNo nullable
ProductTakeRateAnalysisModelobject
PropertyTypeRequiredDetailsDescription
takeRateAnalysisIDstringNo nullable
instanceIDstringNo nullable
productIDstringNo nullable
namestringNo nullable
statusstringNo nullable
lowVolumenumberNo format: double
expectedVolumenumberNo format: double
highVolumenumberNo format: double
safetyStockPercentnumberNo format: double
webhookUrlstringNo nullable
optionsarray of ProductTakeRateOptionModelNo nullable
projectionsarray of ProductTakeRateItemProjectionModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/products/{productID}/take-rate-analyses/{analysisID} PUT /v1/products/{productID}/take-rate-analyses

ProductTakeRateItemProjectionModelobject
PropertyTypeRequiredDetailsDescription
numberstringNo nullable
descriptionstringNo nullable
onHandnumberNo format: double nullable
minimumOrderQuantitynumberNo format: double
minimumOrderQuantityIsAssumedbooleanNo
leadTimeDaysintegerNo format: int32
leadTimeIsAssumedbooleanNo
lowDemandnumberNo format: double
expectedDemandnumberNo format: double
highDemandnumberNo format: double
expectedRecommendedStocknumberNo format: double
expectedNetInventorynumberNo format: double nullable
ProductTakeRateOptionModelobject
PropertyTypeRequiredDetailsDescription
attributeNamestringNo nullable
valuestringNo nullable
takeRatePercentnumberNo format: double
keystringNo nullable
PromotionModelobject
PropertyTypeRequiredDetailsDescription
lineItemIDstringNo nullable
lineNumberintegerNo format: int32
productIDstringNo nullable
workInstructionIDstringNo nullable
workInstructionRevisionIDstringNo nullable
fingerPrintstringNo nullable
sourceDocumentIDstringNo nullable
effectiveSourceDocumentIDstringNo nullable
sourceLineItemIDstringNo nullable
configurationSetIDstringNo nullable
configurationOptionKeystringNo nullable
gbbDisplaySnapshotGbbDisplaySnapshotModelNo
hasConfigurationSelectionbooleanNo
isBatchLinebooleanNo
batchIDstringNo nullable
batchChargeLineIDstringNo nullable
batchSourceLineItemIDsarray of stringNo nullable
hasBatchSourceLineItemsbooleanNo
descriptionstringNo nullable
longDescriptionstringNo nullable
baseMaterialsPricenumberNo format: double
baseTasksPricenumberNo format: double
basePricenumberNo format: double
quantitynumberNo format: double
discountnumberNo format: double
statusstringNo nullable
schedulingPrioritystringNo nullable
schedulingNotesstringNo nullable
leadTimeDaysintegerNo format: int32
leadTimeWeeksnumberNo format: double
attributesarray of LineItemAttrModelNo nullable
tasksarray of LineItemTaskModelNo nullable
itemsarray of LineItemItemAndQtyModelNo nullable
linksarray of DocumentLinkModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
tagsarray of TagModelNo nullable
chargesarray of LineItemChargeModelNo nullable
allowDiscountbooleanNo
lengthUOMstringNo nullable
weightUOMstringNo nullable
showSubTotalstringNo nullable
serializationRequiredstringNo nullable
weightnumberNo format: double
lengthnumberNo format: double
widthnumberNo format: double
heightnumberNo format: double
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
isDeletedbooleanNo
deletedUTCstringNo format: date-time
deletedByUserIDstringNo nullable
promotionIDstringNo nullable
namestringNo nullable
discountPercentnumberNo format: double
salesQuotesarray of stringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
expirationUTCstringNo format: date-time

Used by: PATCH /v1/promotions/{PromotionID} POST /v1/promotions

PurchaseOrderPaymentUploadModelobject
PropertyTypeRequiredDetailsDescription
purchaseOrderNumberstringNo nullable
fileNamestringNo nullable
fileBytesstringNo nullable

Used by: POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder POST /v1/salesquotes/{SalesQuoteID}/payment/purchaseorder/upload

PurchasingWatchHitModelobject
PropertyTypeRequiredDetailsDescription
itemIDstringNo nullable
itemNumberstringNo nullable
itemDescriptionstringNo nullable
ruleIDstringNo nullable
ruleNamestringNo nullable
referenceTypestringNo nullable
referenceIDstringNo nullable
referenceNumberstringNo nullable
detectedUTCstringNo format: date-time

Used by: GET /v1/purchasing/watchlist

PurchasingWatchRuleModelobject
PropertyTypeRequiredDetailsDescription
ruleIDstringNo nullable
instanceIDstringNo nullable
namestringNo nullable
targetFieldWatchRuleTargetFieldNo
operatorWatchRuleOperatorNo
valuestringNo nullable
isActivebooleanNo
createdUTCstringNo format: date-time

Used by: POST /v1/purchasing/rules PUT /v1/purchasing/rules/{id}

QualityAssetCalibrationModelobject
PropertyTypeRequiredDetailsDescription
calibrationIDstringNo nullable
descriptionstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
QualityAssetModelobject
PropertyTypeRequiredDetailsDescription
assetIDstringNo nullable
locationIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
categorystringNo nullable
isActivestringNo nullable
calibrationsarray of QualityAssetCalibrationModelNo nullable
documentsarray of DocumentModelNo nullable
tagsarray of TagModelNo nullable
attributesobjectNo nullable
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
dateNextstringNo format: date-time
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/quality/assets/{AssetID} PATCH /v1/quality/assets/{AssetID}/Notes POST /v1/quality/assets

QualityAuditFindingModelobject
PropertyTypeRequiredDetailsDescription
findingIDstringNo nullable
descriptionstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
QualityAuditModelobject
PropertyTypeRequiredDetailsDescription
auditIDstringNo nullable
locationIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
documentsarray of DocumentModelNo nullable
findingsarray of QualityAuditFindingModelNo nullable
notesarray of NoteModelNo nullable
dateNextstringNo format: date-time
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
qualityCapaIDstringNo nullable
locationIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
statusstringNo nullable
teamUserIDsarray of stringNo nullable
phase1Notesarray of NoteModelNo nullable
phase2Notesarray of NoteModelNo nullable
phase3Notesarray of NoteModelNo nullable
phase4Notesarray of NoteModelNo nullable
phase5Notesarray of NoteModelNo nullable
phase6Notesarray of NoteModelNo nullable
phase7Notesarray of NoteModelNo nullable
phase8Notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/quality/capa/{QualityCapaID} PATCH /v1/quality/capa/{QualityCapaID}/Phases/{Phase}/Notes POST /v1/quality/capa

QualityChangeModelobject
PropertyTypeRequiredDetailsDescription
changeIDstringNo nullable
locationIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/quality/changes/{ChangeID} PATCH /v1/quality/changes/{ChangeID}/Notes POST /v1/quality/changes

QualityDocumentModelobject
PropertyTypeRequiredDetailsDescription
documentIDstringNo nullable
locationIDsarray of stringNo nullable
namestringNo nullable
areastringNo nullable
fileNamestringNo nullable
statusstringNo nullable
revisionintegerNo format: int32
tagsarray of TagModelNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/quality/documents/{DocumentID} PATCH /v1/quality/documents/{DocumentID}/notes

QualityDocumentUploadModelobject
PropertyTypeRequiredDetailsDescription
documentQualityDocumentModelNo
fileNamestringNo nullable
fileBytesstringNo nullable

Used by: POST /v1/quality/documents/add

QualityNcrModelobject
PropertyTypeRequiredDetailsDescription
qualityNcrIDstringNo nullable
locationIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
statusstringNo nullable
keyTypestringNo nullable
keyIDstringNo nullable
assignmentHistoryarray of AssignmentHistoryModelNo nullable
notesarray of NoteModelNo nullable
documentsarray of DocumentModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
productIDstringNo nullable
attributesAndValuesobjectNo nullable

Used by: POST /v1/attributes/{AttributeID}/queries/test

QueryValidValuesModelobject
PropertyTypeRequiredDetailsDescription
namestringNo nullable
xmlstringNo nullable
sqlstringNo nullable
catalogAttributestringNo nullable
catalogFiltersarray of DefinitionAttributeAttrAndValueNo nullable
unitsstringNo nullable
errorstringNo nullable
catalogLookupCatalogLookupDefinitionModelNo
ReassignShipToRequestobject
PropertyTypeRequiredDetailsDescription
newCustomerIDstringNo nullable

Used by: PATCH /v1/customers/{CustomerID}/shipto/{ShipToID}/customer

RecordTextIntegerModelobject
PropertyTypeRequiredDetailsDescription
xstringNo nullable
yIntintegerNo format: int32
ynumberNo 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
PropertyTypeRequiredDetailsDescription
referenceIDstringNo nullable
productIDstringNo nullable
sourceIDstringNo nullable
sourceTypestringNo nullable
targetIDstringNo nullable
targetTypestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
RegressionModelobject
PropertyTypeRequiredDetailsDescription
modelIDstringNo nullable
namestringNo nullable
productIDsarray of stringNo nullable
constantRegressionModelTerm_CONSTANTNo
termsNUMarray of RegressionModelTerm_NUMNo nullable
termsBPVNUMarray of RegressionModelTerm_BPVNUMNo nullable
termsBPVTEXTarray of RegressionModelTerm_BPVTEXTNo nullable
operationstringNo nullable
RegressionModelTerm_BPVNUMobject
PropertyTypeRequiredDetailsDescription
termTypestringNo nullable
attributestringNo nullable
commentstringNo nullable
coefficientnumberNo format: double
minnumberNo format: double
maxnumberNo format: double
RegressionModelTerm_BPVTEXTobject
PropertyTypeRequiredDetailsDescription
termTypestringNo nullable
attributestringNo nullable
commentstringNo nullable
coefficientnumberNo format: double
levelstringNo nullable
isExactMatchbooleanNo
RegressionModelTerm_CONSTANTobject
PropertyTypeRequiredDetailsDescription
commentstringNo nullable
coefficientnumberNo format: double
RegressionModelTerm_NUMobject
PropertyTypeRequiredDetailsDescription
termTypestringNo nullable
attributestringNo nullable
commentstringNo nullable
coefficientnumberNo format: double
operationstringNo nullable
ReleaseNoteApiModelobject
PropertyTypeRequiredDetailsDescription
datestringNo nullable
titlestringNo nullable
markdownstringNo nullable

Used by: GET /v1/releasenotes GET /v1/releasenotes/{date}

RepairSummaryTemplateModelobject
PropertyTypeRequiredDetailsDescription
templateIDstringNo nullable
productIDstringNo nullable
namestringNo nullable
templatestringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/service/repairsummary/templates/{TemplateID} POST /v1/service/repairsummary/templates

ResourceCapacityConstraintModelobject
PropertyTypeRequiredDetailsDescription
constraintTypestringNo nullable
constraintLimitintegerNo format: int32
ResourceCapacityModelobject
PropertyTypeRequiredDetailsDescription
capacityTypestringNo nullable
constraintResourceCapacityConstraintModelNo
ReviewStatusinteger
RoundingOptioninteger
SalesOpportunityModelobject
PropertyTypeRequiredDetailsDescription
opportunityIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
contactNamestringNo nullable
contactEmailstringNo nullable
contactMobilestringNo nullable
titlestringNo nullable
urlstringNo nullable
industryDescriptionstringNo nullable
customerIDstringNo nullable
salesQuoteIDstringNo nullable
statusSalesOpportunityStatusNo
probabilityOfWinningintegerNo format: int32
estimatedRevenuenumberNo format: double
expectedBookingDateUTCstringNo format: date-time
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
peoplearray of PersonModelNo nullable
tagsarray of TagModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo 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
PropertyTypeRequiredDetailsDescription
salesOrderIDstringNo nullable
customerIDstringNo nullable
dateMinstringNo format: date-time
dateMaxstringNo format: date-time

Used by: POST /v1/audit/salesorders/status

SalesOrderDpasModelobject
PropertyTypeRequiredDetailsDescription
isDPASbooleanNo
dpasRatingstringNo nullable
dpasPrioritystringNo nullable
SalesOrderFinishDateModelobject
PropertyTypeRequiredDetailsDescription
salesOrderIDstringNo nullable
finishDatestringNo format: date-time

Used by: POST /v1/salesorders/finishdates

SalesOrderModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
organizationIDstringNo nullable
salesOrderIDstringNo nullable
salesQuoteIDstringNo nullable
billToCustomerBillToModelNo
shipToCustomerShipToModelNo
endCustomerEndCustomerModelNo
contactsarray of PersonModelNo nullable
statusstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
teamIDstringNo nullable
paymentSalesOrderPaymentOptionsModelNo
currencyIDstringNo nullable
currencyCurrencyModelNo
currencyConversionCurrencyConversionModelNo
discountPercentnumberNo format: double
confirmedDatestringNo format: date-time
requestedDatestringNo format: date-time
daysElapsednumberNo format: double
slaCurrentBinSlaBinNo
slaModeSlaModeNo
slaLastEvaluatedUTCstringNo format: date-time
deliveryDeliveryModelNo
optionsSalesOrderOptionsModelNo
createdByUserIDstringNo nullable
ownedByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time
lineItemsarray of LineItemModelNo nullable
itemsarray of ItemAndQtyModelNo nullable
documentsarray of DocumentModelNo nullable
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
tagsarray of TagModelNo nullable
changeOrdersarray of ChangeOrderModelNo nullable

Used by: GET /v1/configure/store/orders GET /v1/salesorders GET /v1/salesorders/{SalesOrderID} GET /v1/salesorders/bycustomer/{CustomerID} GET /v1/salesorders/byquoteid/{SalesQuoteID} GET /v1/salesorders/createdby/{UserID} GET /v1/salesorders/mtd GET /v1/salesorders/search/{ordernumber} GET /v1/salesorders/ytd PATCH /v1/salesorders/{SalesOrderID}/basics PATCH /v1/salesorders/{SalesOrderID}/customer PATCH /v1/salesorders/{SalesOrderID}/history PATCH /v1/salesorders/{SalesOrderID}/items PATCH /v1/salesorders/{SalesOrderID}/lineitems PATCH /v1/salesorders/{SalesOrderID}/notes PATCH /v1/salesorders/{SalesOrderID}/tags POST /v1/salesorders POST /v1/salesorders/byids POST /v1/salesorders/pages/{page} PUT /v1/salesorders

SalesOrderOptionsModelobject
PropertyTypeRequiredDetailsDescription
defaultTemplateIDstringNo nullable
dpasSalesOrderDpasModelNo
SalesOrderPaymentMethodinteger
SalesOrderPaymentOptionsinteger
SalesOrderPaymentOptionsModelobject
PropertyTypeRequiredDetailsDescription
methodSalesOrderPaymentMethodNo
statusSalesQuotePaymentStatusNo
statusUpdatedUTCstringNo format: date-time
paymentTypestringNo nullable
purchaseOrderNumberstringNo nullable
purchaseOrderDocumentIDstringNo nullable
purchaseOrderDateUTCstringNo format: date-time
termsstringNo nullable
creditCardLast4stringNo nullable
creditCardBrandstringNo nullable
paymentTokenIDstringNo nullable
SalesOrderProductionComparisonBomModelobject
PropertyTypeRequiredDetailsDescription
salesOrderItemIDstringNo nullable
productionOrderItemIDstringNo nullable
itemIDstringNo nullable
itemNumberstringNo nullable
itemDescriptionstringNo nullable
salesOrderQuantitynumberNo format: double
productionOrderQuantitynumberNo format: double
salesOrderUnitCostnumberNo format: double
productionOrderUnitCostnumberNo format: double
salesOrderExtendedCostnumberNo format: double
productionOrderExtendedCostnumberNo format: double
comparisonStatusstringNo nullable
SalesOrderProductionComparisonLineModelobject
PropertyTypeRequiredDetailsDescription
comparisonLineIDstringNo nullable
salesOrderLineItemIDstringNo nullable
productIDstringNo nullable
productNumberstringNo nullable
productDescriptionstringNo nullable
productCategorystringNo nullable
salesOrderQuantitynumberNo format: double
productionOrderQuantitynumberNo format: double
revenuenumberNo format: double
plannedLaborMinutesnumberNo format: double
actualLaborMinutesnumberNo format: double
plannedLaborCostnumberNo format: double
actualLaborCostnumberNo format: double
plannedBomCostnumberNo format: double
actualBomCostnumberNo format: double
routerarray of SalesOrderProductionComparisonRouterModelNo nullable
bomarray of SalesOrderProductionComparisonBomModelNo nullable
SalesOrderProductionComparisonModelobject
PropertyTypeRequiredDetailsDescription
comparisonIDstringNo nullable
instanceIDstringNo nullable
salesOrderIDstringNo nullable
salesOrderNumberstringNo nullable
customerIDstringNo nullable
customerNamestringNo nullable
statusstringNo nullable
salesOrderCompletedUTCstringNo format: date-time
generatedUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time
generatedByUserIDstringNo nullable
sourceFingerprintstringNo nullable
currencyIDstringNo nullable
revenuenumberNo format: double
plannedLaborMinutesnumberNo format: double
actualLaborMinutesnumberNo format: double
plannedLaborCostnumberNo format: double
actualLaborCostnumberNo format: double
plannedBomCostnumberNo format: double
actualBomCostnumberNo format: double
linesarray of SalesOrderProductionComparisonLineModelNo nullable

Used by: PATCH /v1/salesorders/analysis/production-comparisons/{id} PUT /v1/salesorders/analysis/production-comparisons

SalesOrderProductionComparisonRouterModelobject
PropertyTypeRequiredDetailsDescription
salesOrderTaskIDstringNo nullable
productionOrderTaskIDstringNo nullable
taskNumberintegerNo format: int32
taskNamestringNo nullable
salesOrderPlanMinutesnumberNo format: double
productionOrderPlanMinutesnumberNo format: double
actualMinutesnumberNo format: double
hourlyRatenumberNo format: double
hourlyRateSourcestringNo nullable
plannedLaborCostnumberNo format: double
actualLaborCostnumberNo format: double
planVarianceMinutesnumberNo format: double
actualVarianceMinutesnumberNo format: double
comparisonStatusstringNo nullable
SalesOrderProductionComparisonSlicerModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
productIDstringNo nullable
categorystringNo nullable
yearintegerNo format: int32
monthintegerNo format: int32
dateFromUTCstringNo format: date-time nullable
dateToUTCstringNo format: date-time nullable
pageintegerNo format: int32
recordsPerPageintegerNo format: int32

Used by: POST /v1/salesorders/analysis/production-comparisons POST /v1/salesorders/analysis/production-comparisons/count

SalesOrderProfitabilityExportResponseModelobject
PropertyTypeRequiredDetailsDescription
exportedintegerNo format: int32
resultFileNamestringNo nullable
resultUrlstringNo nullable
logFileNamestringNo nullable
logUrlstringNo nullable
calculationLogstringNo nullable

Used by: GET /v1/salesorders/export/profitability

SalesOrderSlaModelobject
PropertyTypeRequiredDetailsDescription
salesOrderIDstringNo nullable
numberstringNo nullable
daysElapsednumberNo format: double
customerIDstringNo nullable
customerNamestringNo nullable
ceilingintegerNo format: int32
diffintegerNo format: int32
statusstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
createdYearintegerNo format: int32
createdMonthintegerNo format: int32
productIDstringNo nullable
productNamestringNo nullable

Used by: POST /v1/salesorders/sla

SalesOrderSlicerModelobject
PropertyTypeRequiredDetailsDescription
statusstringNo nullable
createdstringNo nullable
customerIDstringNo nullable
productIDstringNo nullable
teamIDstringNo nullable
havingAttributeNamestringNo nullable
havingTaskNamestringNo nullable
daysElapsedintegerNo format: int32
daysElapsedEndintegerNo format: int32
createdYearintegerNo format: int32
createdMonthintegerNo format: int32
sortBystringNo nullable
sortOrderstringNo 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
PropertyTypeRequiredDetailsDescription
paymentRequiredToReleasestringNo nullable
allowPurchaseOrdersbooleanNo
showDPASbooleanNo
carryOverProductionOrderAssignedResourceIDbooleanNo
SalesOrderStatusUpdateModelobject
PropertyTypeRequiredDetailsDescription
statusstringNo nullable

Used by: PATCH /v1/salesorders/{SalesOrderID}/status

SalesOrderWorkModelobject
PropertyTypeRequiredDetailsDescription
salesOrderSalesOrderModelNo
prodOrdersarray of ProductionOrderModelNo nullable

Used by: GET /v1/salesorders/schedule GET /v1/salesorders/work

SalesQuoteAnalysisLineModelobject
PropertyTypeRequiredDetailsDescription
yearintegerNo format: int32
monthintegerNo format: int32
monthLabelstringNo nullable
createdByUserIDstringNo nullable
createdBystringNo nullable
smartQuoteCountintegerNo format: int32
skuCountintegerNo format: int32
customCountintegerNo format: int32

Used by: POST /v1/salesquotes/analysis/lines

SalesQuoteAuditSlicerModelobject
PropertyTypeRequiredDetailsDescription
salesQuoteIDstringNo nullable
customerIDstringNo nullable
dateMinstringNo format: date-time
dateMaxstringNo format: date-time

Used by: POST /v1/audit/salesquotes/phase POST /v1/audit/salesquotes/status

SalesQuoteEmailLogModelobject
PropertyTypeRequiredDetailsDescription
logIDstringNo nullable
salesQuoteIDstringNo nullable
createdByUserIDstringNo nullable
messageEmailMessageModelNo
createdUTCstringNo format: date-time

Used by: PUT /v1/salesquotes/logs/email

SalesQuoteIncotermModelobject
PropertyTypeRequiredDetailsDescription
termIDstringNo nullable
codestringNo nullable
namestringNo nullable
descriptionstringNo nullable
locationstringNo nullable
effectiveYearintegerNo format: int32
SalesQuoteIndexPageModelobject
PropertyTypeRequiredDetailsDescription
salesQuotesarray of SalesQuoteModelNo nullable
customersarray of CustomerModelNo nullable
totalRecordsintegerNo format: int32

Used by: POST /v1/salesquotes/index/pages/{page}

SalesQuoteLineCommercialTermsModelobject
PropertyTypeRequiredDetailsDescription
salesQuoteIDstringNo nullable
lineIDstringNo nullable
commercialRelationshipIDstringNo nullable
commercialRelationshipNamestringNo nullable
relationshipTypestringNo nullable
sellingEntitystringNo nullable
supplyingEntitystringNo nullable
agreementIDstringNo nullable
agreementVersionstringNo nullable
unitCostOverridenumberNo format: double nullable
underlyingGroupCostnumberNo format: double nullable

Used by: GET /v1/salesquotes/{salesQuoteId}/commercial-terms PUT /v1/salesquotes/{salesQuoteId}/lines/{lineId}/commercial-terms

SalesQuoteMarginApprovalModelobject
PropertyTypeRequiredDetailsDescription
eventIDstringNo nullable
processIDstringNo nullable
definitionIDstringNo nullable
salesQuoteIDstringNo nullable
lineIDstringNo nullable
lineRevisionstringNo nullable
calculationSnapshotIDstringNo nullable
calculatorIDstringNo nullable
calculatorVersionstringNo nullable
kaiMarginPercentnumberNo format: double nullable
globalMarginPercentnumberNo format: double nullable
sisterCompanyMarginPercentnumberNo format: double nullable
policyTargetPercentnumberNo format: double nullable
policySourcestringNo nullable
transitionIDstringNo nullable
approvedByUserIDstringNo nullable
approvedUTCstringNo format: date-time

Used by: GET /v1/salesquotes/{salesQuoteId}/margin-approvals

SalesQuoteModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
organizationIDstringNo nullable
salesQuoteIDstringNo nullable
statusstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
additionalNotesstringNo nullable
teamIDstringNo nullable
customerIDstringNo nullable
customerCustomerBillToModelNo
billToCustomerBillToModelNo
contactsarray of PersonModelNo nullable
documentsarray of DocumentModelNo nullable
incotermSalesQuoteIncotermModelNo
discountPercentnumberNo format: double
currencyIDstringNo nullable
currencyCurrencyModelNo
currencyConversionCurrencyConversionModelNo
paymentTermsstringNo nullable
paymentSalesOrderPaymentOptionsModelNo
leadTimeWeeksnumberNo format: double
validityDaysintegerNo format: int32
validityStartUTCstringNo format: date-time
validUntilUTCstringNo format: date-time
pdfGeneratedUTCstringNo format: date-time
phasestringNo nullable
deliveryDeliveryModelNo
optionsSalesQuoteOptionsModelNo
createdByUserIDstringNo nullable
ownedByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time
lineItemsarray of LineItemModelNo nullable
itemsarray of ItemAndQtyModelNo nullable
historyarray of HistoryModelNo nullable
notesarray of NoteModelNo nullable
tagsarray of TagModelNo 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
PropertyTypeRequiredDetailsDescription
showTotalPricestringNo nullable
defaultTemplateIDstringNo nullable
SalesQuotePaymentStatusinteger
SalesQuotePaymentTokenRequestModelobject
PropertyTypeRequiredDetailsDescription
tokenstringNo nullable

Used by: POST /v1/salesquotes/{SalesQuoteID}/payment/cc

SalesQuotePhaseUpdateModelobject
PropertyTypeRequiredDetailsDescription
phasestringNo nullable

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/phase

SalesQuotesAnalysisCustomersModelobject
PropertyTypeRequiredDetailsDescription
recordsarray of RecordTextIntegerModelNo nullable
heatMapDataarray of HeatMapDataModelNo nullable
xLabelsarray of stringNo nullable
yLabelsarray of stringNo nullable

Used by: POST /v1/salesquotes/analysis/customers

SalesQuoteSimulationModelobject
PropertyTypeRequiredDetailsDescription
simulationIDstringNo nullable
salesQuoteIDstringNo nullable
createdByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/simulations/{SimulationID} POST /v1/salesquotes/{SalesQuoteID}/simulations

SalesQuoteSlicerModelobject
PropertyTypeRequiredDetailsDescription
createdByUserIDstringNo nullable
statusstringNo nullable
createdstringNo nullable
phasestringNo nullable
customerIDstringNo nullable
productIDstringNo nullable
teamIDstringNo nullable
paymentStatusSalesQuotePaymentStatusNo
createdYearintegerNo format: int32 nullable
createdMonthintegerNo format: int32 nullable
sortBystringNo nullable
sortOrderstringNo nullable

Used by: POST /v1/salesquotes POST /v1/salesquotes/analysis/aging POST /v1/salesquotes/analysis/conversion POST /v1/salesquotes/analysis/createdby POST /v1/salesquotes/analysis/createdon POST /v1/salesquotes/analysis/customers POST /v1/salesquotes/analysis/lines POST /v1/salesquotes/analysis/phase POST /v1/salesquotes/analysis/status POST /v1/salesquotes/count POST /v1/salesquotes/export/lineitems POST /v1/salesquotes/export/summary POST /v1/salesquotes/index/pages/{page} POST /v1/salesquotes/pages/{page} POST /v1/salesquotes/pages/{page}/customers POST /v1/salesquotes/recent

SalesQuotesSettingsModelobject
PropertyTypeRequiredDetailsDescription
additionalNotesstringNo nullable
quantityDiscountAllowedbooleanNo
allowSkuQuotingbooleanNo
allowCustomQuotingbooleanNo
leaderboardEnabledbooleanNo
marginApprovalViaProcessbooleanNo
governedSkuPricingEnabledbooleanNo
paymentRequiredbooleanNo
publicCheckoutEnabledbooleanNo
requireCheckoutSignaturebooleanNo
paymentOptionsSalesOrderPaymentOptionsNo
enableMockHelcimbooleanNo
attributeDescriptionMaxLengthintegerNo format: int32
releaseModestringNo nullable
SalesQuoteStatusUpdateModelobject
PropertyTypeRequiredDetailsDescription
statusstringNo nullable

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/status PATCH /v1/salesquotes/{SalesQuoteID}/status/historical

SalesQuoteUpdateValidityModelobject
PropertyTypeRequiredDetailsDescription
salesQuoteIDstringNo nullable
validityDaysintegerNo format: int32
validityStartUTCstringNo format: date-time

Used by: PATCH /v1/salesquotes/{SalesQuoteID}/validity

ScheduleResequenceRequestModelobject
PropertyTypeRequiredDetailsDescription
requestIDstringNo nullable
productionOrderIDstringNo nullable
requestedByUserIDstringNo nullable
requestedUTCstringNo format: date-time
reasonstringNo nullable
statusstringNo nullable
processedByUserIDstringNo nullable
processedUTCstringNo format: date-time nullable

Used by: PATCH /v1/schedule/resequence/requests/{RequestID} POST /v1/schedule/resequence/requests POST /v1/schedule/resequence/requests/create

ScheduleResequenceRequestSlicerModelobject
PropertyTypeRequiredDetailsDescription
statusstringNo nullable
productionOrderIDstringNo nullable
requestedByUserIDstringNo nullable
limitintegerNo format: int32

Used by: POST /v1/schedule/resequence/requests/all POST /v1/schedule/resequence/requests/count POST /v1/schedule/resequence/requests/pages/{page}

ScheduleSlicerModelobject
PropertyTypeRequiredDetailsDescription
customerIDstringNo nullable
assignedResourceIDstringNo nullable
statusintegerNo format: int32
phaseStringFilterNo
tagLabelstringNo nullable
tagValuestringNo nullable
percentCompleteintegerNo format: int32
daysElapsedintegerNo format: int32
daysElapsedEndintegerNo format: int32
plannedStartUTCstringNo format: date-time nullable
plannedEndUTCstringNo format: date-time nullable
orderBystringNo nullable
orderstringNo 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
PropertyTypeRequiredDetailsDescription
algorithmstringNo nullable
attributesarray of stringNo nullable
batchSizeintegerNo format: int32
keepLineItemsTogetherstringNo nullable
SerializationSerialNumberModelobject
PropertyTypeRequiredDetailsDescription
serialIDstringNo nullable
numberstringNo nullable
customerIDstringNo nullable
itemIDstringNo nullable
statusstringNo nullable
warrantyStartUTCstringNo format: date-time
warrantyEndUTCstringNo format: date-time
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
isWarrantybooleanNo

Used by: PATCH /v1/serialization/{SerialID} PATCH /v1/serialization/{SerialID}/batch PUT /v1/serialization PUT /v1/serialization/batch

ServiceCodeModelobject
PropertyTypeRequiredDetailsDescription
codeIDstringNo nullable
productIDstringNo nullable
codeTypestringNo nullable
categorystringNo nullable
codestringNo nullable
descriptionstringNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/service/codes/{CodeID} POST /v1/service/codes

ServiceTicketLineItemModelobject
PropertyTypeRequiredDetailsDescription
lineItemIDstringNo nullable
serialIDstringNo nullable
problemReportedstringNo nullable
salesQuoteIDstringNo nullable
salesQuoteLineItemIDstringNo nullable
salesOrderIDstringNo nullable
salesOrderLineItemIDstringNo nullable
notesarray of NoteModelNo nullable
ServiceTicketModelobject
PropertyTypeRequiredDetailsDescription
ticketIDstringNo nullable
numberstringNo nullable
statusintegerNo format: int32
statusEnumTicketStatusNo
customerIDstringNo nullable
lineItemsarray of ServiceTicketLineItemModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/service/tickets/{TicketID} PUT /v1/service/tickets PUT /v1/service/tickets/batch

ServiceTicketSlicerModelobject
PropertyTypeRequiredDetailsDescription
statusTicketStatusNo
yearintegerNo format: int32
monthintegerNo format: int32

Used by: POST /v1/service/tickets/pages/{page}

SftpExportFileSettingsModelobject
PropertyTypeRequiredDetailsDescription
enabledbooleanNo
exportTypestringNo nullable
remotePathstringNo nullable
fileNamestringNo nullable
fromDateUTCstringNo format: date-time
SftpExportSettingsModelobject
PropertyTypeRequiredDetailsDescription
enabledbooleanNo
hoststringNo nullable
portintegerNo format: int32
userNamestringNo nullable
filesarray of SftpExportFileSettingsModelNo nullable
intervalMinutesintegerNo format: int32
hasPasswordbooleanNo
SftpExportUpdateModelobject
PropertyTypeRequiredDetailsDescription
settingsSftpExportSettingsModelNo
passwordstringNo nullable

Used by: POST /v1/instances/{InstanceID}/settings/sftp-export

SlaBininteger
SlackWebhookDefinitionobject
PropertyTypeRequiredDetailsDescription
slackWebhookIDstringNo nullable
namestringNo nullable
webhookUrlstringNo nullable
channelstringNo nullable
userNamestringNo nullable
isActivebooleanNo
SlaModeinteger
SmartQuoteVersionModelobject
PropertyTypeRequiredDetailsDescription
versionIDstringNo nullable
productIDstringNo nullable
labelstringNo nullable
statestringNo nullable
isReleasedbooleanNo
attributesJSONstringNo nullable
rulesJSONstringNo nullable
ruleGroupsJSONstringNo nullable
itemMappingJSONstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time
createdByUserIDstringNo nullable
lastUpdatedByUserIDstringNo 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
PropertyTypeRequiredDetailsDescription
stateSmartQuoteVersionStateNo
isReleasedbooleanNo

Used by: PATCH /v1/instances/{InstanceID}/smartquote/{ProductID}/versions/{VersionID}/state

StateMachineDiagramModelobject
PropertyTypeRequiredDetailsDescription
mermaidstringNo nullable

Used by: GET /v1/salesorders/statemachines/status GET /v1/salesquotes/statemachines/payment GET /v1/salesquotes/statemachines/status

StoreCatalogProductModelobject
PropertyTypeRequiredDetailsDescription
storeIDstringNo nullable
productIDstringNo nullable
namestringNo nullable
familyIDstringNo nullable
familystringNo nullable
tagsarray of stringNo nullable
imageUrlstringNo nullable
sortOrderintegerNo format: int32
leadTimeDaysintegerNo format: int32
showPricingbooleanNo

Used by: GET /v1/configure/store/products

StoreCustomerCreateobject
PropertyTypeRequiredDetailsDescription
emailstringNo nullable
companyNamestringNo nullable
firstNamestringNo nullable
lastNamestringNo nullable
userIdstringNo nullable
isWebshopbooleanNo

Used by: POST /v1/configure/store/customers

StoreItemCatalogModelobject
PropertyTypeRequiredDetailsDescription
storeIDstringNo nullable
itemIDstringNo nullable
numberstringNo nullable
descriptionstringNo nullable
longDescriptionstringNo nullable
categorystringNo nullable
uomstringNo nullable
unitPricenumberNo format: double
leadTimeDaysintegerNo format: int32
minimumOrderQuantitynumberNo format: double
lifecycleStatusstringNo nullable
availabilityStatusstringNo nullable
priceBreaksarray of ItemPriceBreakModelNo nullable

Used by: GET /v1/items/store/catalog

StringFilterobject
PropertyTypeRequiredDetailsDescription
valuestringNo nullable
modeFilterModeNo
isActivebooleanNo
SupplierModelobject
PropertyTypeRequiredDetailsDescription
supplierIDstringNo nullable
numberstringNo nullable
namestringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
countrystringNo nullable
postalCodestringNo nullable
isApprovedstringNo nullable
notesarray of NoteModelNo nullable
historyarray of HistoryModelNo nullable
peoplearray of PersonModelNo nullable
createdByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/suppliers/{SupplierID}/basics PATCH /v1/suppliers/{SupplierID}/notes PATCH /v1/suppliers/{SupplierID}/people PUT /v1/suppliers

SupplierPriceBreakModelobject
PropertyTypeRequiredDetailsDescription
breakIDstringNo nullable
quantityMinnumberNo format: double
quantityMaxnumberNo format: double
pricenumberNo format: double
costnumberNo format: double
SupplierProcessCostModelobject
PropertyTypeRequiredDetailsDescription
processCodestringNo nullable
unitCostnumberNo format: double
TagLabelModelobject
PropertyTypeRequiredDetailsDescription
labelstringNo nullable
categorystringNo nullable
dataTypestringNo nullable
sortOrderintegerNo format: int32
isRequiredstringNo nullable
allowEditstringNo nullable
tagTypestringNo nullable
validValuesarray of stringNo nullable
labelIDstringNo nullable
entitystringNo nullable

Used by: POST /v1/instances/defaulttags POST /v1/setup/defaulttags

TagModelobject
PropertyTypeRequiredDetailsDescription
labelstringNo nullable
categorystringNo nullable
dataTypestringNo nullable
sortOrderintegerNo format: int32
isRequiredstringNo nullable
allowEditstringNo nullable
tagTypestringNo nullable
validValuesarray of stringNo nullable
tagIDstringNo nullable
valuestringNo nullable
TaskCapacityConstraintModelobject
PropertyTypeRequiredDetailsDescription
constraintTypestringNo nullable
constraintLimitintegerNo format: int32
TaskCapacityModelobject
PropertyTypeRequiredDetailsDescription
capacityTypestringNo nullable
constraintTaskCapacityConstraintModelNo
TaskModelUpdateModelobject
PropertyTypeRequiredDetailsDescription
xmlstringNo nullable

Used by: PATCH /v1/tasks/{TaskID}/model/cost PATCH /v1/tasks/{TaskID}/model/time

TeamMemberModelobject
PropertyTypeRequiredDetailsDescription
teamIDstringNo nullable
userIDstringNo nullable
rolestringNo nullable
joinedUTCstringNo format: date-time

Used by: POST /v1/teams/{TeamID}/members

TeamModelobject
PropertyTypeRequiredDetailsDescription
teamIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
isActivestringNo nullable
membersarray of TeamMemberModelNo nullable
notesarray of NoteModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: GET /v1/teams GET /v1/teams/{TeamID} GET /v1/teams/my POST /v1/teams PUT /v1/teams/{TeamID}

TenantFullExportRequestobject
PropertyTypeRequiredDetailsDescription
exportIDstringNo nullable
componentIDstringNo nullable
cutoffUTCstringNo format: date-time
contractVersionstringNo nullable

Used by: POST /v1/internal/tenants/{tenantID}/exports

TenantGroupMemberModelobject
PropertyTypeRequiredDetailsDescription
memberIDstringNo nullable
groupIDstringNo nullable
instanceIDstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/instances/groups/{GroupID}/members

TenantGroupModelobject
PropertyTypeRequiredDetailsDescription
groupIDstringNo nullable
namestringNo nullable
descriptionstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: POST /v1/instances/groups

TenantNoteCreateModelobject
PropertyTypeRequiredDetailsDescription
categorystringNo nullable
statusstringNo nullable
summarystringNo nullable
detailstringNo nullable
sourceReferencestringNo nullable
metadataJSONstringNo nullable

Used by: POST /v1/tenants/{tenantId}/notes

TenantNoteModelobject
PropertyTypeRequiredDetailsDescription
tenantNoteIDstringNo nullable
instanceIDstringNo nullable
categorystringNo nullable
statusstringNo nullable
summarystringNo nullable
detailstringNo nullable
sourceReferencestringNo nullable
metadataJSONstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
resolvedByUserIDstringNo nullable
resolvedUTCstringNo format: date-time nullable
isDeletedbooleanNo

Used by: GET /v1/tenants/{tenantId}/notes GET /v1/tenants/{tenantId}/notes/{noteId} POST /v1/tenants/{tenantId}/notes PUT /v1/tenants/{tenantId}/notes/{noteId}

TenantNoteUpdateModelobject
PropertyTypeRequiredDetailsDescription
categorystringNo nullable
statusstringNo nullable
summarystringNo nullable
detailstringNo nullable
sourceReferencestringNo nullable
metadataJSONstringNo nullable

Used by: PUT /v1/tenants/{tenantId}/notes/{noteId}

TenantProvisioningRequestobject
PropertyTypeRequiredDetailsDescription
tenantIDstringNo nullable
appIDstringNo nullable
companyTypestringNo nullable
tenantInstanceModelNo

Used by: POST /v1/provisioning/tenants POST /v1/tenant-provisioning

TenantProvisioningResponseobject
PropertyTypeRequiredDetailsDescription
tenantIDstringNo nullable
statusstringNo nullable

Used by: POST /v1/provisioning/tenants POST /v1/tenant-provisioning

TenantProvisioningStatusModelobject
PropertyTypeRequiredDetailsDescription
tenantIDstringNo nullable
statusstringNo nullable
lastErrorstringNo nullable
stepsarray of TenantProvisioningStepStatusModelNo nullable

Used by: GET /v1/provisioning/tenants/{tenantId} GET /v1/tenant-provisioning/{tenantId}

TenantProvisioningStepStatusModelobject
PropertyTypeRequiredDetailsDescription
stepNamestringNo nullable
statusstringNo nullable
detailstringNo nullable
TenantSeedProfileModelobject
PropertyTypeRequiredDetailsDescription
idstringNo nullable
displayNamestringNo nullable
versionstringNo nullable
manifestHashstringNo nullable
provisioningTenantSeedProvisioningGuideModelNo

Used by: GET /v1/provisioning/profiles GET /v1/tenant-seed-profiles

TenantSeedProfileVersionModelobject
PropertyTypeRequiredDetailsDescription
profileIDstringNo nullable
displayNamestringNo nullable
versionstringNo nullable
statusstringNo nullable
manifestJsonstringNo nullable
manifestHashstringNo nullable
createdByUserIDstringNo nullable
lastUpdatedByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time
publishedUTCstringNo format: date-time nullable

Used by: GET /v1/provisioning/profiles/{profileId}/versions GET /v1/provisioning/profiles/{profileId}/versions/{version} GET /v1/tenant-seed-profiles/{profileId}/versions GET /v1/tenant-seed-profiles/{profileId}/versions/{version} POST /v1/provisioning/profiles POST /v1/tenant-seed-profiles

TenantSeedProfileVersionWriteModelobject
PropertyTypeRequiredDetailsDescription
profileIDstringNo nullable
displayNamestringNo nullable
versionstringNo nullable
manifestJsonstringNo nullable

Used by: POST /v1/provisioning/profiles POST /v1/tenant-seed-profiles PUT /v1/provisioning/profiles/{profileId}/versions/{version} PUT /v1/tenant-seed-profiles/{profileId}/versions/{version}

TenantSeedProvisioningGuideModelobject
PropertyTypeRequiredDetailsDescription
summarystringNo nullable
questionsarray of TenantSeedProvisioningQuestionModelNo nullable
TenantSeedProvisioningQuestionModelobject
PropertyTypeRequiredDetailsDescription
keystringNo nullable
labelstringNo nullable
helpTextstringNo nullable
inputTypestringNo nullable
requiredbooleanNo
defaultValuestringNo nullable
optionsarray of stringNo nullable
TenantSeedRequestobject
PropertyTypeRequiredDetailsDescription
seedProfilestringNo nullable
seedProfileVersionstringNo nullable
seedProfileHashstringNo nullable
provisioningAnswersobjectNo nullable

Used by: POST /v1/provisioning/tenants/{tenantId}/seed-runs POST /v1/tenants/{tenantId}/seed-runs

TenantSeedResponseobject
PropertyTypeRequiredDetailsDescription
runIDstringNo nullable
tenantIDstringNo nullable
seedProfilestringNo nullable
seedProfileVersionstringNo nullable
seedProfileHashstringNo nullable
statusstringNo nullable

Used by: POST /v1/provisioning/tenants/{tenantId}/seed-runs POST /v1/tenants/{tenantId}/seed-runs

TenantSeedRunStatusModelobject
PropertyTypeRequiredDetailsDescription
runIDstringNo nullable
tenantIDstringNo nullable
seedProfilestringNo nullable
seedProfileVersionstringNo nullable
seedProfileHashstringNo nullable
statusstringNo nullable
errorstringNo nullable

Used by: GET /v1/provisioning/tenants/{tenantId}/seed-runs/{runId} GET /v1/tenants/{tenantId}/seed-runs/{runId}

TicketStatusinteger
ToDoModelobject
PropertyTypeRequiredDetailsDescription
toDoIDstringNo nullable
referenceIDstringNo nullable
referenceTypestringNo nullable
statusintegerNo format: int32
descriptionstringNo nullable
scopestringNo nullable
createdByUserIDstringNo nullable
dueDateUTCstringNo format: date-time
createdUTCstringNo format: date-time
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/todo PUT /v1/todo

TroubleCorrectiveActionModelobject
PropertyTypeRequiredDetailsDescription
actionstringNo nullable
preventionstringNo nullable
failureAnalysisstringNo nullable
repairsarray of TroubleRepairModelNo nullable
notesTextstringNo nullable
notesListarray of stringNo nullable
TroubleProfileModelobject
PropertyTypeRequiredDetailsDescription
partNumberstringNo nullable
serialNumberstringNo nullable
revisionstringNo nullable
dateOfManufacturestringNo format: date-time
dateOfManufactureDatestringNo nullable
notesstringNo nullable
TroubleRepairMaterialModelobject
PropertyTypeRequiredDetailsDescription
materialIDstringNo nullable
origPartNumberstringNo nullable
origDescriptionstringNo nullable
origRevisionstringNo nullable
origSerialNumberstringNo nullable
origNotesstringNo nullable
newPartNumberstringNo nullable
newDescriptionstringNo nullable
newRevisionstringNo nullable
newSerialNumberstringNo nullable
newNotesstringNo nullable
quantitynumberNo format: double
uomstringNo nullable
purchaseOrderNumberstringNo nullable
lotNumberstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
TroubleRepairModelobject
PropertyTypeRequiredDetailsDescription
repairIDstringNo nullable
categorystringNo nullable
codestringNo nullable
descriptionstringNo nullable
origPartNumberstringNo nullable
origRevisionstringNo nullable
origSerialNumberstringNo nullable
newPartNumberstringNo nullable
newRevisionstringNo nullable
newSerialNumberstringNo nullable
newNotesarray of NoteModelNo nullable
incidentalMaterialsarray of TroubleRepairMaterialModelNo nullable
TroubleReportModelobject
PropertyTypeRequiredDetailsDescription
instanceIDstringNo nullable
reportIDstringNo nullable
numberstringNo nullable
statusstringNo nullable
productionOrderIDstringNo nullable
serviceTicketIDstringNo nullable
serviceTicketLineItemIDstringNo nullable
problemReportedstringNo nullable
repairSummarystringNo nullable
profileIncomingTroubleProfileModelNo
profileOutgoingTroubleProfileModelNo
symptomsarray of TroubleSymptomModelNo nullable
documentReferencesarray of DocumentReferenceModelNo nullable
linksarray of DocumentLinkModelNo nullable
notesarray of NoteModelNo nullable
tagsarray of TagModelNo nullable
historyarray of HistoryModelNo nullable
auditarray of AuditRecordModelNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/service/troublereports/{ReportID} PUT /v1/service/troublereports

TroubleReportSlicerModelobject
PropertyTypeRequiredDetailsDescription
statusstringNo nullable
customerIDstringNo nullable
productIDstringNo nullable
searchForstringNo nullable
limitintegerNo 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
PropertyTypeRequiredDetailsDescription
symptomIDstringNo nullable
categorystringNo nullable
codestringNo nullable
descriptionstringNo nullable
causeCategorystringNo nullable
causeCodestringNo nullable
causeDescriptionstringNo nullable
correctiveActionTroubleCorrectiveActionModelNo
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
UpdateCreatedByModelobject
PropertyTypeRequiredDetailsDescription
origUserIDstringNo nullable
newUserIDstringNo nullable

Used by: PATCH /v1/prodorders/createdby PATCH /v1/salesorders/createdby PATCH /v1/salesquotes/createdby PATCH /v1/service/reports/createdby

UpdateItemStoreAvailabilityModelobject
PropertyTypeRequiredDetailsDescription
availableForStorebooleanNo

Used by: PATCH /v1/items/{itemID}/store

UserModelobject
PropertyTypeRequiredDetailsDescription
userIDstringNo nullable
firststringNo nullable
laststringNo nullable
titlestringNo nullable
emailAddressstringNo nullable
phoneNumbersarray of PhoneNumberModelNo nullable
phoneOfficestringNo nullable
phoneMobilestringNo nullable
addressstringNo nullable
citystringNo nullable
statestringNo nullable
postalCodestringNo nullable
countrystringNo nullable
managerUserIDstringNo nullable
resetRequiredstringNo nullable
isActivestringNo nullable
offsetUTCnumberNo format: double
globalRolesarray of stringNo nullable
instanceAccessarray of UserTenantAccessModelNo nullable
profilesarray of UserProfileBaseModelNo nullable

Used by: GET /v1/configure/store/users

UserProfileBaseModelobject
PropertyTypeRequiredDetailsDescription
profileIDstringNo nullable
userIDstringNo nullable
organizationIDstringNo nullable
timeZoneIDstringNo nullable
createdUTCstringNo format: date-time
createdByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
notificationPreferencesNotificationPreferencesModelNo
webInterfacePreferencesobjectNo nullable
UserTenantAccessModelobject
PropertyTypeRequiredDetailsDescription
accessIDstringNo nullable
userIDstringNo nullable
instanceIDstringNo nullable
organizationIDstringNo nullable
apiKeystringNo nullable
rolesarray of stringNo nullable
permissionsarray of stringNo nullable
createdUTCstringNo format: date-time
createdByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
UserTourModelobject
PropertyTypeRequiredDetailsDescription
tourIDstringNo nullable
completedbooleanNo
completedUTCstringNo format: date-time

Used by: PATCH /v1/tours/{TourID}

VerticalModelobject
PropertyTypeRequiredDetailsDescription
verticalIDstringNo nullable
namestringNo nullable
targetMarginPercentnumberNo format: double nullable
isActivebooleanNo

Used by: GET /v1/verticals GET /v1/verticals/{VerticalID} POST /v1/verticals PUT /v1/verticals/{VerticalID}

ViewHistoryModelobject
PropertyTypeRequiredDetailsDescription
viewIDstringNo nullable
userIDstringNo nullable
controllerstringNo nullable
keyIDstringNo nullable
subKeyIDstringNo nullable
descriptionstringNo nullable
routestringNo nullable
createdUTCstringNo format: date-time
WatchRuleOperatorinteger
WatchRuleTargetFieldinteger
WebhookLogModelobject
PropertyTypeRequiredDetailsDescription
webhookLogIDstringNo nullable
webhookIDstringNo nullable
entitystringNo nullable
entityIDstringNo nullable
eventstringNo nullable
baseUrlstringNo nullable
resourcestringNo nullable
resultstringNo nullable
detailstringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
responseStatusCodeTextstringNo nullable
responseStatusCodeintegerNo format: int32 nullable
responseBodystringNo nullable
requestPayloadstringNo nullable
requestHeadersstringNo nullable
durationMsintegerNo format: int64

Used by: POST /v1/webhooks/logs

WebhookLogSlicerModelobject
PropertyTypeRequiredDetailsDescription
entitystringNo nullable
eventstringNo nullable
yearintegerNo format: int32
monthintegerNo format: int32
pageintegerNo format: int32

Used by: POST /v1/webhooks/logs/count POST /v1/webhooks/logs/pages

WebhookModelobject
PropertyTypeRequiredDetailsDescription
webhookIDstringNo nullable
entitystringNo nullable
eventstringNo nullable
descriptionstringNo nullable
baseUrlstringNo nullable
resourcestringNo nullable
methodstringNo nullable
headersJsonstringNo nullable
secretstringNo nullable
slackSendbooleanNo
slackWebhookUrlstringNo nullable
slackUserNamestringNo nullable
slackChannelstringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/webhooks/{WebHookID} POST /v1/webhooks

WorkDayModelobject
PropertyTypeRequiredDetailsDescription
workDayIDstringNo nullable
namestringNo nullable
dayOfWeekintegerNo format: int32
hoursarray of WorkTimeModelNo nullable
WorkTimeModelobject
PropertyTypeRequiredDetailsDescription
workTimeIDstringNo nullable
timeStartstringNo format: date-time
timeStopstringNo format: date-time
XmlTemplateModelobject
PropertyTypeRequiredDetailsDescription
templateIDstringNo nullable
namestringNo nullable
appliesTostringNo nullable
templatestringNo nullable
isActivestringNo nullable
createdByUserIDstringNo nullable
createdUTCstringNo format: date-time
lastUpdatedByUserIDstringNo nullable
lastUpdatedUTCstringNo format: date-time

Used by: PATCH /v1/xml/templates/{TemplateID} POST /v1/xml/templates