Skip to main content
POST
List Consumption Records V2

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

Filter by organization ID

Example:

"1700000000000x444444444444444444"

limit
integer<int32>
default:100
required
Required range: 1 <= x <= 200
Example:

100

offset
integer<int32>
default:0
required
Required range: x >= 0
Example:

0

id
string

Filter by consumption record ID

Example:

"1700000000000x000000000000000000"

home_clinic
string

Filter by home clinic ID

Example:

"1700000000000x111111111111111111"

subscription
string

Filter by subscription ID

Example:

"1700000000000x333333333333333333"

pet
string

Filter by pet ID

Example:

"1700000000000x555555555555555555"

invoice_line
string

Filter by Bubble invoice line ID

Example:

"1700000000000x666666666666666666"

invoice_line_id
string

Filter by PIMS invoice line ID

Example:

"INV-LINE-789"

product_code
string

Filter by product code

Example:

"VACC-RABIES"

modified_since
string<date-time>

Filter: internal modified_date >= value

Example:

"2025-01-01T00:00:00Z"

created_at_since
string<date-time>

Filter: bubble created date >= value

Example:

"2025-01-01T00:00:00Z"

updated_at_since
string<date-time>

Filter: bubble modified date >= value

Example:

"2025-01-01T00:00:00Z"

include_deleted
boolean
default:false

Include soft-deleted rows

Example:

false

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>