Update a usage product inventory

patch/usage-product-inventories/{usage_product_inventory_id}
SecuritybearerAuth
Request
path Parameters
usage_product_inventory_id
required
integer <int64> (IdParam) >= 1

Usage product inventory identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "add",
    • "path": "string",
    • "value": { },
    • "from": "string"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "siteId": 1,
  • "usageProductId": 1,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "supplierAccountId": 0,
  • "billByServiceId": false,
  • "serviceId": "string",
  • "billable": true,
  • "inFlightOrder": false,
  • "externalOrderReference": "string",
  • "externalNetworkOrderReference": "string",
  • "pendingEndDate": "2019-08-24",
  • "usageCapEnabled": false,
  • "defaultUsageCap": 0,
  • "applySurcharges": false,
  • "productReferences": [
    • {
      • "id": 1,
      • "productReference": "string",
      • "primary": true,
      • "label": "string",
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24",
      • "userId": "string",
      • "userEmail": "string",
      • "costCentreCode": "string",
      • "departmentCode": "string",
      • "notes": "string"
      }
    ]
}