Create a new usage product

post/usage-products
SecuritybearerAuth
Request
Request Body schema: application/json

New usage product

name
required
string [ 1 .. 100 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Usage product name

nominalCode
string [ 1 .. 100 ] characters ^[\w\p{L}\s%£@&#=':;,`’|!_—–()/\-+.?*$\[\]€^{...

Nominal code

usageProductCategoryId
required
integer <int64>

Usage product category identifier

direction
required
string (UsageProductDirection)

Usage product direction

Enum: "INBOUND" "OUTBOUND"
performLocalAndNationalCheck
boolean
Default: true

Perform local and national check

availableFrom
required
string <date>

Product is available from

availableTo
string <date>

Product is available to

productReferenceCanBeRange
boolean
Default: true

Product reference can be range

serviceIdRequired
boolean
Default: false

Service id is required on rental product inventories

Array of objects (CustomField)
productReferenceFormat
required
string non-empty

Regular expression used to validate product references on usage product inventories

serviceIdFormat
string non-empty

Regular expression used to validate service ids on usage product inventories

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "name": "string",
  • "nominalCode": "SALES-01QTR2",
  • "usageProductCategoryId": 1,
  • "direction": "INBOUND",
  • "performLocalAndNationalCheck": true,
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "productReferenceCanBeRange": true,
  • "serviceIdRequired": false,
  • "customFields": [
    • {
      • "label": "string",
      • "value": "string"
      }
    ],
  • "productReferenceFormat": "[0-9]{3,11}",
  • "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
}
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "nominalCode": "SALES-01QTR2",
  • "usageProductCategoryId": 1,
  • "direction": "INBOUND",
  • "performLocalAndNationalCheck": true,
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "productReferenceCanBeRange": true,
  • "serviceIdRequired": false,
  • "customFields": [
    • {
      • "id": 1,
      • "label": "string",
      • "value": "string"
      }
    ],
  • "productReferenceFormat": "[0-9]{3,11}",
  • "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
}