Bill updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

BillSchema · object

required

Show child attributes

data.id

string

The unique ID of the bill.

Example:

"bill_id_1"

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the bill. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

data.created_date

string<date-time>

The date the bill was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the bill was last updated.

Example:

"2022-01-02T05:05:05Z"

data.object_id

string | null

The ID of the object that incurred a charge.

Example:

"object_id"

data.object_type

string | null

The type of object that incurred a charge.

Example:

"order"

data.charge_type

string

The reason for the charge.

Example:

"shipping"

data.amount

number

The amount charged.

Example:

10.5

data.currency_code

string

The currency of the charge. Defaults to USD.

Example:

"USD"

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"bill.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

previous_attributes

BillSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the bill.

Example:

"bill_id_1"

previous_attributes.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the bill. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

previous_attributes.created_date

string<date-time>

The date the bill was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

The date the bill was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.object_id

string | null

The ID of the object that incurred a charge.

Example:

"object_id"

previous_attributes.object_type

string | null

The type of object that incurred a charge.

Example:

"order"

previous_attributes.charge_type

string

The reason for the charge.

Example:

"shipping"

previous_attributes.amount

number

The amount charged.

Example:

10.5

previous_attributes.currency_code

string

The currency of the charge. Defaults to USD.

Example:

"USD"

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Body

Response