Skip to main content
PATCH
Partially Update Usage Event

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

A reported usage fact — the client write path. The server prices the quantity into ledger rows (records) on create and re-expands them on update.

performance_obligation
integer
usage_date
string<date>
description
string
Maximum string length: 500
quantity
number<double>
Required range: -100000000000 < x < 100000000000
currency
string
Maximum string length: 3

Response

200 - application/json

A reported usage fact — the client write path. The server prices the quantity into ledger rows (records) on create and re-expands them on update.

id
integer
required
read-only
performance_obligation
integer
required
obligation_name
string
required
read-only
contract
integer
required
read-only
contract_name
string
required
read-only
contract_number
string
required
read-only
client_name
string
required
read-only
usage_date
string<date>
required
records
object[]
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
description
string
Maximum string length: 500
quantity
number<double>
Required range: -100000000000 < x < 100000000000
currency
string
Maximum string length: 3