getMaterialUsedIn

READ

Get material used in.

POST /api/v1/items/getMaterialUsedIn

curl -X POST '<your-host>/api/v1/items/getMaterialUsedIn' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "itemId": "string"
  }'

Response

{
  "issues": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "jobMaterials": [
    {
      "id": "string",
      "methodType": "Purchase to Order",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "maintenanceDispatchItems": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "methodMaterials": [
    {
      "id": "string",
      "methodType": "Purchase to Order",
      "documentId": "string",
      "version": 0,
      "documentReadableId": "string",
      "documentParentId": "string",
      "itemType": "Part"
    }
  ],
  "purchaseOrderLines": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "receiptLines": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "quoteMaterials": [
    {
      "id": "string",
      "methodType": "Purchase to Order",
      "documentParentId": "string",
      "documentId": "string",
      "documentReadableId": "string"
    }
  ],
  "salesOrderLines": [
    {
      "id": "string",
      "methodType": "Purchase to Order",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "shipmentLines": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "supplierQuotes": [
    {
      "id": "string",
      "documentReadableId": "string",
      "documentId": "string"
    }
  ],
  "inspections": [
    {
      "id": "string",
      "documentReadableId": "string"
    }
  ],
  "jobMaterialUsage": {
    "byMaterialId": {
      "…": 0
    },
    "byJobId": {
      "…": 0
    }
  }
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "itemId": {
      "type": "string"
    }
  },
  "required": [
    "itemId"
  ]
}