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