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