Skip to main content
images/intakeq.svg

Parameters

Action
Parameters
{
  "$result_object_key": {
    "additional_email_recipients": [
      "[email protected]",
      "[email protected]"
    ],
    "amount_due": 100,
    "amount_paid": 175,
    "automated": true,
    "client_email": "[email protected]",
    "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"
  }
}
{
  "$result_object_key": {
    "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"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.
Invoice
Fetch Action Response Object