Events
Triggering Webhook Types
The following event types are associated with the Invoice event payload from Intakeq.Intakeq Invoice IssuedIntakeq Invoice PaidIntakeq Invoice Payment Plan Charge FailedIntakeq Invoice Auto Charge FailedIntakeq Invoice CancelledIntakeq Invoice Payment Refunded
{
"additional_email_recipients": [
"billing@example.com",
"accounts@example.com"
],
"amount_due": 100,
"amount_paid": 175,
"automated": true,
"client_email": "john.doe@example.com",
"client_id": "client_12345",
"client_id_number": 12345,
"client_name": "John Doe",
"client_payment_plan_id": "plan_12345",
"client_payment_plan_interval": 30,
"created_at": "2023-01-10T00:00:00Z",
"currency_iso": "USD",
"discount_amount": 25.5,
"discount_percent": 10,
"discount_type": "Percentage",
"due_date": "2023-02-15T00:00:00Z",
"id": "inv_12345",
"issue_date": "2023-01-15T00:00:00Z",
"items": [
{
"appointment_id": "appt_12345",
"date": "2023-01-15T00:00:00Z",
"description": "Initial consultation",
"is_copay": true,
"price": 100,
"product_id": "prod_12345",
"service_code": "SVC001",
"sub_items": [
{
"date": "2023-01-16T00:00:00Z",
"description": "Follow-up session",
"modifiers": [
"Extended",
"Emergency"
],
"price": 50,
"service_code": "SVC002",
"units": 2,
"units_decimal": 2
}
],
"taxes": [
{
"name": "Sales Tax",
"percentage": 8.25
}
],
"taxes_included_in_price": false,
"total_amount": 110,
"total_tax_amount": 10,
"units": 1,
"units_decimal": 2
}
],
"note_to_client": "Thank you for your business",
"number": 1001,
"payments": [
{
"additional_info": "Customer requested partial refund",
"amount": 100,
"card_details": {
"brand": "Visa",
"card_id": "card_12345",
"expiration_month": 12,
"expiration_year": 2025,
"last_digits": "4242"
},
"currency": "USD",
"date": "2023-01-20T00:00:00Z",
"method": "Credit Card",
"processed_by": "Stripe",
"processed_by_type": "Payment Processor",
"refunded_amount": 25,
"tip_amount": 15
}
],
"status": "Paid",
"subtotal": 250,
"tip_amount": 15,
"total_amount": 275,
"updated_at": "2023-01-12T00:00:00Z"
}
{
"additional_email_recipients": "Additional email addresses to receive the invoice",
"amount_due": "Amount still due on the invoice",
"amount_paid": "Amount already paid on the invoice",
"automated": "Whether the invoice was automatically generated",
"client_email": "Email address of the client",
"client_id": "Client identifier",
"client_id_number": "Numeric client identifier",
"client_name": "Name of the client",
"client_payment_plan_id": "Identifier for the client's payment plan",
"client_payment_plan_interval": "Interval for the client's payment plan",
"created_at": "Date when the invoice was created",
"currency_iso": "ISO code for the currency",
"discount_amount": "Discount amount applied to the invoice",
"discount_percent": "Discount percentage applied to the invoice",
"discount_type": "Type of discount applied",
"due_date": "Date when the invoice is due",
"id": "Unique identifier for the invoice",
"issue_date": "Date when the invoice was issued",
"items": {
"appointment_id": "Identifier of the associated appointment",
"date": "Date associated with the item",
"description": "Description of the item",
"is_copay": "Whether this item is a copay",
"price": "Price per unit",
"product_id": "Identifier of the product",
"service_code": "Service code for this item",
"sub_items": {
"date": "Date associated with the sub-item",
"description": "Description of the sub-item",
"modifiers": "Modifiers applied to this sub-item",
"price": "Price of the sub-item",
"service_code": "Service code for this sub-item",
"units": "Number of units, DEPRECATED: use units_decimal, this value might be truncated",
"units_decimal": "Number of units"
},
"taxes": {
"name": "Name of the tax",
"percentage": "Percentage rate of the tax"
},
"taxes_included_in_price": "Whether taxes are included in the price",
"total_amount": "Total amount for this item",
"total_tax_amount": "Total tax amount for this item",
"units": "Number of units, DEPRECATED: use units_decimal, this value might be truncated",
"units_decimal": "Number of units"
},
"note_to_client": "Note included on the invoice for the client",
"number": "Invoice number",
"payments": {
"additional_info": "Additional information about the payment",
"amount": "Amount of the payment",
"card_details": {
"brand": "Brand of the card",
"card_id": "Identifier for the card",
"expiration_month": "Expiration month of the card",
"expiration_year": "Expiration year of the card",
"last_digits": "Last digits of the card number"
},
"currency": "Currency of the payment",
"date": "Date of the payment",
"method": "Payment method used",
"processed_by": "Entity that processed the payment",
"processed_by_type": "Type of entity that processed the payment",
"refunded_amount": "Amount refunded from this payment",
"tip_amount": "Tip amount included in the payment"
},
"status": "Current status of the invoice",
"subtotal": "Subtotal amount before taxes and discounts",
"tip_amount": "Tip amount included in the invoice",
"total_amount": "Total amount of the invoice",
"updated_at": "Date when the invoice was last modified"
}
Payload Field Details
Event Payload
Hide fields
Hide fields
string
required
Unique identifier for the invoice
CEL
id
Example
"inv_12345"
string
Name of the client
CEL
client_name
Example
"John Doe"
string
Email address of the client
CEL
client_email
Example
"john.doe@example.com"
string
required
Client identifier
CEL
client_id
Example
"client_12345"
int64
Numeric client identifier
CEL
client_id_number
Example
12345
int64
Invoice number
CEL
number
Example
1001
timing.v1.Timestamp
Date when the invoice was issued
CEL
issue_date
Example
"2023-01-15T00:00:00Z"
string
Current status of the invoice
CEL
status
Example
"Paid"
timing.v1.Timestamp
Date when the invoice is due
CEL
due_date
Example
"2023-02-15T00:00:00Z"
string
ISO code for the currency
CEL
currency_iso
Example
"USD"
float64 (double)
Discount percentage applied to the invoice
CEL
discount_percent
Example
10
float64 (double)
Discount amount applied to the invoice
CEL
discount_amount
Example
25.5
string
Type of discount applied
CEL
discount_type
Example
"Percentage"
float64 (double)
Subtotal amount before taxes and discounts
CEL
subtotal
Example
250
float64 (double)
Total amount of the invoice
CEL
total_amount
Example
275
float64 (double)
Amount still due on the invoice
CEL
amount_due
Example
100
float64 (double)
Amount already paid on the invoice
CEL
amount_paid
Example
175
string
Note included on the invoice for the client
CEL
note_to_client
Example
"Thank you for your business"
float64 (double)
Tip amount included in the invoice
CEL
tip_amount
Example
15
bool
Whether the invoice was automatically generated
CEL
automated
Example
true
[]string
required
Additional email addresses to receive the invoice
CEL
additional_email_recipients
Example
[
"billing@example.com",
"accounts@example.com"
]
string
Identifier for the client’s payment plan
CEL
client_payment_plan_id
Example
"plan_12345"
int64
Interval for the client’s payment plan
CEL
client_payment_plan_interval
Example
30
timing.v1.Timestamp
Date when the invoice was created
CEL
created_at
Example
"2023-01-10T00:00:00Z"
timing.v1.Timestamp
Date when the invoice was last modified
CEL
updated_at
Example
"2023-01-12T00:00:00Z"
[]object
required
Payments made against this invoice
CEL
payments
Example
[
{
"additional_info": "Customer requested partial refund",
"amount": 100,
"card_details": {
"brand": "Visa",
"card_id": "card_12345",
"expiration_month": 12,
"expiration_year": 2025,
"last_digits": "4242"
},
"currency": "USD",
"date": "2023-01-20T00:00:00Z",
"method": "Credit Card",
"processed_by": "Stripe",
"processed_by_type": "Payment Processor",
"refunded_amount": 25,
"tip_amount": 15
}
]
[]timing.v1.Timestamp
required
Mapped array of: Date of the payment
CEL
payments.map(x, x.date)
Example
[
"2023-01-20T00:00:00Z"
]
[]float64 (double)
required
Mapped array of: Amount of the payment
CEL
payments.map(x, x.amount)
Example
[
100
]
[]string
required
Mapped array of: Currency of the payment
CEL
payments.map(x, x.currency)
Example
[
"USD"
]
[]string
required
Mapped array of: Payment method used
CEL
payments.map(x, x.method)
Example
[
"Credit Card"
]
[]string
required
Mapped array of: Entity that processed the payment
CEL
payments.map(x, x.processed_by)
Example
[
"Stripe"
]
[]string
required
Mapped array of: Type of entity that processed the payment
CEL
payments.map(x, x.processed_by_type)
Example
[
"Payment Processor"
]
[]float64 (double)
required
Mapped array of: Tip amount included in the payment
CEL
payments.map(x, x.tip_amount)
Example
[
15
]
[]float64 (double)
required
Mapped array of: Amount refunded from this payment
CEL
payments.map(x, x.refunded_amount)
Example
[
25
]
[]string
required
Mapped array of: Additional information about the payment
CEL
payments.map(x, x.additional_info)
Example
[
"Customer requested partial refund"
]
[]bool
required
Mapped array of: Details of the card used for payment
CEL
payments.map(x, x.card_details)
Example
[
{
"brand": "Visa",
"card_id": "card_12345",
"expiration_month": 12,
"expiration_year": 2025,
"last_digits": "4242"
}
]
[]object
required
Line items included in this invoice
CEL
items
Example
[
{
"appointment_id": "appt_12345",
"date": "2023-01-15T00:00:00Z",
"description": "Initial consultation",
"is_copay": true,
"price": 100,
"product_id": "prod_12345",
"service_code": "SVC001",
"sub_items": [
{
"date": "2023-01-16T00:00:00Z",
"description": "Follow-up session",
"modifiers": [
"Extended",
"Emergency"
],
"price": 50,
"service_code": "SVC002",
"units": 2,
"units_decimal": 2
}
],
"taxes": [
{
"name": "Sales Tax",
"percentage": 8.25
}
],
"taxes_included_in_price": false,
"total_amount": 110,
"total_tax_amount": 10,
"units": 1,
"units_decimal": 2
}
]
[]string
required
Mapped array of: Identifier of the associated appointment
CEL
items.map(x, x.appointment_id)
Example
[
"appt_12345"
]
[]string
required
Mapped array of: Identifier of the product
CEL
items.map(x, x.product_id)
Example
[
"prod_12345"
]
[]string
required
Mapped array of: Description of the item
CEL
items.map(x, x.description)
Example
[
"Initial consultation"
]
[]float64 (double)
required
Mapped array of: Total tax amount for this item
CEL
items.map(x, x.total_tax_amount)
Example
[
10
]
[]int64
required
Mapped array of: Number of units, DEPRECATED: use units_decimal, this value might be truncated
CEL
items.map(x, x.units)
Example
[
1
]
[]float64 (double)
required
Mapped array of: Price per unit
CEL
items.map(x, x.price)
Example
[
100
]
[]timing.v1.Timestamp
required
Mapped array of: Date associated with the item
CEL
items.map(x, x.date)
Example
[
"2023-01-15T00:00:00Z"
]
[]bool
required
Mapped array of: Taxes applied to this item
CEL
items.map(x, x.taxes)
Example
[
[
{
"name": "Sales Tax",
"percentage": 8.25
}
]
]
[]bool
required
Mapped array of: Whether taxes are included in the price
CEL
items.map(x, x.taxes_included_in_price)
Example
[
false
]
[]bool
required
Mapped array of: Whether this item is a copay
CEL
items.map(x, x.is_copay)
Example
[
true
]
[]float64 (double)
required
Mapped array of: Total amount for this item
CEL
items.map(x, x.total_amount)
Example
[
110
]
[]string
required
Mapped array of: Service code for this item
CEL
items.map(x, x.service_code)
Example
[
"SVC001"
]
[]bool
required
Mapped array of: Sub-items included in this item
CEL
items.map(x, x.sub_items)
Example
[
[
{
"date": "2023-01-16T00:00:00Z",
"description": "Follow-up session",
"modifiers": [
"Extended",
"Emergency"
],
"price": 50,
"service_code": "SVC002",
"units": 2,
"units_decimal": 2
}
]
]
[]float64 (double)
required
Mapped array of: Number of units
CEL
items.map(x, x.units_decimal)
Example
[
2
]