Skip to main content
POST
/
consumption
List Consumption Records
curl --request POST \
  --url https://nestvet.com/api/1.1/wf/consumption \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": "<string>",
  "limit": 123,
  "offset": 123,
  "clinic": "<string>",
  "id": "<string>",
  "invoice_line_id": "<string>",
  "invoice_line_pims_id": "<string>",
  "subscription_id": "<string>",
  "created_at_since": "2023-11-07T05:31:56Z",
  "updated_at_since": "2023-11-07T05:31:56Z"
}
'
[
  {
    "id": "<string>",
    "clinic": "<string>",
    "invoice_pims_id": "<string>",
    "invoice_date": "2023-11-07T05:31:56Z",
    "invoice_line": "<string>",
    "invoice_line_aje_delta": 123,
    "invoice_line_pims_id": "<string>",
    "pet": "<string>",
    "pet_benefit": "<string>",
    "product_code": "<string>",
    "product_name": "<string>",
    "qty_available_on_plan": 123,
    "qty_consumed": 123,
    "qty_consumed_accum": 123,
    "qty_in_plan": 123,
    "qty_out_of_plan": 123,
    "qty_remaining": 123,
    "revenue_in_plan_total": 123,
    "revenue_out_of_plan_total": 123,
    "revenue_to_recognize_total": 123,
    "revenue_to_recognize_per_unit": 123,
    "subscription": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organization
string
required
limit
integer<int32>
required
offset
integer<int32>
required
clinic
string
id
string
invoice_line_id
string
invoice_line_pims_id
string
subscription_id
string
created_at_since
string<date-time>
updated_at_since
string<date-time>

Response

200 - application/json

A list of consumption records

id
string
clinic
string
invoice_pims_id
string
invoice_date
string<date-time>
invoice_line
string
invoice_line_aje_delta
number<double>
invoice_line_pims_id
string
pet
string
pet_benefit
string
product_code
string
product_name
string
qty_available_on_plan
integer
qty_consumed
integer
qty_consumed_accum
integer
qty_in_plan
integer
qty_out_of_plan
integer
qty_remaining
integer
revenue_in_plan_total
number<double>
revenue_out_of_plan_total
number<double>
revenue_to_recognize_total
number<double>
revenue_to_recognize_per_unit
number<double>
subscription
string
created_at
string<date-time>
updated_at
string<date-time>