Path parameters

• workOrderUuid string(uuid) Required

  Uuid of the work order.

Query parameters

• continuationToken string

  The continuation token which was received in the previous request. It contains information on the page to fetch. If not present, then the first page of results will be returned.

• pageSize integer

  Maximum number of items returned per page. Hard limit 200.

  Minimum value is 1, maximum value is 200. Default value is 200.

• invoiceMode string

  Filter items by billing ownership.

  • external - items charged to an external party (customer-facing invoice).
  • internal - items consumed internally (sub-contractor or internal cost).
  • all - no filter, returns all items regardless of invoice mode (default).

  Values are external, internal, or all. Default value is all.

Responses

• 200 application/json

  OK - Paginated list of used items on the work order.

  Hide response attributes Show response attributes object

  • continuationToken string | null

    Opaque token. Pass on next request. null means last page. Do not parse or construct.

  • data array[object] Required
    Hide data attributes Show data attributes object

    • lineItemId string(uuid) Required

      Unique cart-line identifier. Stable across work order re-openings. Use for precise invoicing and reconciliation with expected items.

    • itemCode string Required

      Code of the consumed item (catalogue or on-the-fly).

    • agentCode string | null

      Code of the agent who declared this line (technician or web user).

    • billing object Required
      Hide billing attributes Show billing attributes object

      • associatedSectionCode string | null

        Quotation section code. null if declared directly on the work order cart.

      • invoiceMode string Required

        EXTERNAL = customer invoice. INTERNAL = sub-contractor or internal cost.

        Values are EXTERNAL or INTERNAL.

      • name string | null

        Item display name.

      • reference string | null

        Item reference code.

      • expectedQuantity number(double) | null

        Pre-ordered quantity. null if no expectation was set.

      • usedQuantity number(double) Required

        Actual quantity consumed.

        Minimum value is 0.

      • usedVatRate number(double) | null

        VAT rate (e.g. 0.20 for 20%). null if not declared.

      • unitPrice object
        Hide unitPrice attributes Show unitPrice attributes object

        • catalogValue number(double) | null

          Catalogue unit price. null for on-the-fly items.

        • associatedContract string | null

          Contract code that overrode the catalogue price. null if none applies.

        • value number(double) | null

          Effective unit price applied to this item line.

        • currency string

          ISO 4217 currency code of the eTech account.

    • tracking object Required
      Hide tracking attributes Show tracking attributes object

      • serialNumber string | null

        Serial number. null if not tracked by serial number.

      • stockCode string | null

        Stock location code. null if not tracked by stock.

    • lastUpdate string(date-time) Required

      ISO 8601 UTC. Results sorted by this field, descending.

• 400 application/json

  Bad Request - validation error or invalid continuation token.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 401 application/json

  Unauthorized - authentication issue.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 403 application/json

  Forbidden - not enough rights.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 404 application/json

  Not Found - Work order not found or outside caller's org unit.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 429 application/json

  Too Many Requests.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 500 application/json

  Internal server error.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].