Sign in
NCRs

Open a new NCR in status New. An affected job and/or item become the NCR's single impact; the job's customer and sales order are recorded from the job itself. The NCR number is assigned by the server. Creates are not idempotent: a retried request opens a second NCR.

post/api/ncrs

Request body

titlestring nullable

Short title for the NCR

typestring required

The NCR type, one of the shop's configured NCR types (for example Quality, Quantity, Customer Complaint, Return, Warranty)

detailstring required

What was found: the required description of the non-conformance

causestring nullable

The cause, one of the shop's configured NCR causes

reasonstring nullable

The reason, one of the shop's configured NCR reasons

dispositionstring nullable

Disposition, when already decided. One of: Acceptable - Customer, Acceptable - Engineer, Conforming, Hold, Return To Customer, Return To Vendor, Return To Fulcrum, Rework, Remake/Replace, Scrap - Customer

jobIdstring nullable

The affected job's id. The job's customer and sales order are recorded on the impact from the job

itemIdstring nullable

The affected item's id. Defaults to the job's parent item when only a job is given

quantityImpactednumber double nullable

How many units are affected. Requires jobId or itemId. Zero or greater

quantityImpactedDispositionstring nullable

Whether the impacted quantity is All, Partial, or Unknown. Defaults to Partial

Response

The created NCR

idstring required

Unique id associated to this entity.

numberinteger required

Number

typestring required

NCR Type

causestring required

Cause

detailstring required

Detail - required notes on the NCR

departmentIdstring nullable

Department key identifier. Please reference /api/departments endpoint.

vendorIdstring nullable

Vendor key identifier. Please reference /api/vendors endpoint.

workCentersstring nullable

The work centers assigned to this NCR.

scheduledEquipmentstring nullable

Affected Equipment

reasonstring nullable

Reason

statusstring nullable

NCR Status

quantityImpactednumber double nullable

Quantity Impacted

incrementalCostnumber double nullable

Incremental Cost

createdUtcstring date-time nullable

Created Date

completedUtcstring date-time nullable

Completed Date

jobIdsstring[]

Impacted Job IDs

customFieldsobject nullable

Custom fields that have been defined on this entity.

Changes

Changed in 1 of the 23 revisions of this API.1