> ## 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.

# Get Invoice

> Documentation for the Get Invoice action for Intakeq

![images/intakeq.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/intakeq.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=191a6c088f13edff5cd7f23a84babb49)

# Parameters

**Action** `Parameters`

**parameters**

**Invoice ID** `string` *required*

`ID`
This field maps to the destination API `invoiceId` field.

```json Result Object Example theme={null}
{
  "$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"
  }
}
```

```json Result Object Description theme={null}
{
  "$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 an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**Invoice** `Fetch Action Response Object`

**fields**

**id** `string` *required*

Unique identifier for the invoice

```json CEL theme={null}
$result_object_key.id
```

```json Example theme={null}
"inv_12345"
```

**client\_name** `string`

Name of the client

```json CEL theme={null}
$result_object_key.client_name
```

```json Example theme={null}
"John Doe"
```

**client\_email** `string`

Email address of the client

```json CEL theme={null}
$result_object_key.client_email
```

```json Example theme={null}
"john.doe@example.com"
```

**client\_id** `string` *required*

Client identifier

```json CEL theme={null}
$result_object_key.client_id
```

```json Example theme={null}
"client_12345"
```

**client\_id\_number** `int64`

Numeric client identifier

```json CEL theme={null}
$result_object_key.client_id_number
```

```json Example theme={null}
12345
```

**number** `int64`

Invoice number

```json CEL theme={null}
$result_object_key.number
```

```json Example theme={null}
1001
```

**issue\_date** `timing.v1.Timestamp`

Date when the invoice was issued

```json CEL theme={null}
$result_object_key.issue_date
```

```json Example theme={null}
"2023-01-15T00:00:00Z"
```

**status** `string`

Current status of the invoice

```json CEL theme={null}
$result_object_key.status
```

```json Example theme={null}
"Paid"
```

**due\_date** `timing.v1.Timestamp`

Date when the invoice is due

```json CEL theme={null}
$result_object_key.due_date
```

```json Example theme={null}
"2023-02-15T00:00:00Z"
```

**currency\_iso** `string`

ISO code for the currency

```json CEL theme={null}
$result_object_key.currency_iso
```

```json Example theme={null}
"USD"
```

**discount\_percent** `float64 (double)`

Discount percentage applied to the invoice

```json CEL theme={null}
$result_object_key.discount_percent
```

```json Example theme={null}
10
```

**discount\_amount** `float64 (double)`

Discount amount applied to the invoice

```json CEL theme={null}
$result_object_key.discount_amount
```

```json Example theme={null}
25.5
```

**discount\_type** `string`

Type of discount applied

```json CEL theme={null}
$result_object_key.discount_type
```

```json Example theme={null}
"Percentage"
```

**subtotal** `float64 (double)`

Subtotal amount before taxes and discounts

```json CEL theme={null}
$result_object_key.subtotal
```

```json Example theme={null}
250
```

**total\_amount** `float64 (double)`

Total amount of the invoice

```json CEL theme={null}
$result_object_key.total_amount
```

```json Example theme={null}
275
```

**amount\_due** `float64 (double)`

Amount still due on the invoice

```json CEL theme={null}
$result_object_key.amount_due
```

```json Example theme={null}
100
```

**amount\_paid** `float64 (double)`

Amount already paid on the invoice

```json CEL theme={null}
$result_object_key.amount_paid
```

```json Example theme={null}
175
```

**note\_to\_client** `string`

Note included on the invoice for the client

```json CEL theme={null}
$result_object_key.note_to_client
```

```json Example theme={null}
"Thank you for your business"
```

**tip\_amount** `float64 (double)`

Tip amount included in the invoice

```json CEL theme={null}
$result_object_key.tip_amount
```

```json Example theme={null}
15
```

**automated** `bool`

Whether the invoice was automatically generated

```json CEL theme={null}
$result_object_key.automated
```

```json Example theme={null}
true
```

**additional\_email\_recipients** `[]string` *required*

Additional email addresses to receive the invoice

```json CEL theme={null}
$result_object_key.additional_email_recipients
```

```json Example theme={null}
[
"billing@example.com",
"accounts@example.com"
]
```

**client\_payment\_plan\_id** `string`

Identifier for the client's payment plan

```json CEL theme={null}
$result_object_key.client_payment_plan_id
```

```json Example theme={null}
"plan_12345"
```

**client\_payment\_plan\_interval** `int64`

Interval for the client's payment plan

```json CEL theme={null}
$result_object_key.client_payment_plan_interval
```

```json Example theme={null}
30
```

**created\_at** `timing.v1.Timestamp`

Date when the invoice was created

```json CEL theme={null}
$result_object_key.created_at
```

```json Example theme={null}
"2023-01-10T00:00:00Z"
```

**updated\_at** `timing.v1.Timestamp`

Date when the invoice was last modified

```json CEL theme={null}
$result_object_key.updated_at
```

```json Example theme={null}
"2023-01-12T00:00:00Z"
```

**payments** `[]object` *required*

Payments made against this invoice

```json CEL theme={null}
$result_object_key.payments
```

```json Example theme={null}
[
{
"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
}
]
```

**payments.map(x, x.date)** `[]timing.v1.Timestamp` *required*

Mapped array of: Date of the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.date)
```

```json Example theme={null}
[
"2023-01-20T00:00:00Z"
]
```

**payments.map(x, x.amount)** `[]float64 (double)` *required*

Mapped array of: Amount of the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.amount)
```

```json Example theme={null}
[
100
]
```

**payments.map(x, x.currency)** `[]string` *required*

Mapped array of: Currency of the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.currency)
```

```json Example theme={null}
[
"USD"
]
```

**payments.map(x, x.method)** `[]string` *required*

Mapped array of: Payment method used

```json CEL theme={null}
$result_object_key.payments.map(x, x.method)
```

```json Example theme={null}
[
"Credit Card"
]
```

**payments.map(x, x.processed\_by)** `[]string` *required*

Mapped array of: Entity that processed the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.processed_by)
```

```json Example theme={null}
[
"Stripe"
]
```

**payments.map(x, x.processed\_by\_type)** `[]string` *required*

Mapped array of: Type of entity that processed the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.processed_by_type)
```

```json Example theme={null}
[
"Payment Processor"
]
```

**payments.map(x, x.tip\_amount)** `[]float64 (double)` *required*

Mapped array of: Tip amount included in the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.tip_amount)
```

```json Example theme={null}
[
15
]
```

**payments.map(x, x.refunded\_amount)** `[]float64 (double)` *required*

Mapped array of: Amount refunded from this payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.refunded_amount)
```

```json Example theme={null}
[
25
]
```

**payments.map(x, x.additional\_info)** `[]string` *required*

Mapped array of: Additional information about the payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.additional_info)
```

```json Example theme={null}
[
"Customer requested partial refund"
]
```

**payments.map(x, x.card\_details)** `[]bool` *required*

Mapped array of: Details of the card used for payment

```json CEL theme={null}
$result_object_key.payments.map(x, x.card_details)
```

```json Example theme={null}
[
{
"brand": "Visa",
"card_id": "card_12345",
"expiration_month": 12,
"expiration_year": 2025,
"last_digits": "4242"
}
]
```

**items** `[]object` *required*

Line items included in this invoice

```json CEL theme={null}
$result_object_key.items
```

```json Example theme={null}
[
{
"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
}
]
```

**items.map(x, x.appointment\_id)** `[]string` *required*

Mapped array of: Identifier of the associated appointment

```json CEL theme={null}
$result_object_key.items.map(x, x.appointment_id)
```

```json Example theme={null}
[
"appt_12345"
]
```

**items.map(x, x.product\_id)** `[]string` *required*

Mapped array of: Identifier of the product

```json CEL theme={null}
$result_object_key.items.map(x, x.product_id)
```

```json Example theme={null}
[
"prod_12345"
]
```

**items.map(x, x.description)** `[]string` *required*

Mapped array of: Description of the item

```json CEL theme={null}
$result_object_key.items.map(x, x.description)
```

```json Example theme={null}
[
"Initial consultation"
]
```

**items.map(x, x.total\_tax\_amount)** `[]float64 (double)` *required*

Mapped array of: Total tax amount for this item

```json CEL theme={null}
$result_object_key.items.map(x, x.total_tax_amount)
```

```json Example theme={null}
[
10
]
```

**items.map(x, x.units)** `[]int64` *required*

Mapped array of: Number of units, DEPRECATED: use units\_decimal, this value might be truncated

```json CEL theme={null}
$result_object_key.items.map(x, x.units)
```

```json Example theme={null}
[
1
]
```

**items.map(x, x.price)** `[]float64 (double)` *required*

Mapped array of: Price per unit

```json CEL theme={null}
$result_object_key.items.map(x, x.price)
```

```json Example theme={null}
[
100
]
```

**items.map(x, x.date)** `[]timing.v1.Timestamp` *required*

Mapped array of: Date associated with the item

```json CEL theme={null}
$result_object_key.items.map(x, x.date)
```

```json Example theme={null}
[
"2023-01-15T00:00:00Z"
]
```

**items.map(x, x.taxes)** `[]bool` *required*

Mapped array of: Taxes applied to this item

```json CEL theme={null}
$result_object_key.items.map(x, x.taxes)
```

```json Example theme={null}
[
[
{
"name": "Sales Tax",
"percentage": 8.25
}
]
]
```

**items.map(x, x.taxes\_included\_in\_price)** `[]bool` *required*

Mapped array of: Whether taxes are included in the price

```json CEL theme={null}
$result_object_key.items.map(x, x.taxes_included_in_price)
```

```json Example theme={null}
[
false
]
```

**items.map(x, x.is\_copay)** `[]bool` *required*

Mapped array of: Whether this item is a copay

```json CEL theme={null}
$result_object_key.items.map(x, x.is_copay)
```

```json Example theme={null}
[
true
]
```

**items.map(x, x.total\_amount)** `[]float64 (double)` *required*

Mapped array of: Total amount for this item

```json CEL theme={null}
$result_object_key.items.map(x, x.total_amount)
```

```json Example theme={null}
[
110
]
```

**items.map(x, x.service\_code)** `[]string` *required*

Mapped array of: Service code for this item

```json CEL theme={null}
$result_object_key.items.map(x, x.service_code)
```

```json Example theme={null}
[
"SVC001"
]
```

**items.map(x, x.sub\_items)** `[]bool` *required*

Mapped array of: Sub-items included in this item

```json CEL theme={null}
$result_object_key.items.map(x, x.sub_items)
```

```json Example theme={null}
[
[
{
"date": "2023-01-16T00:00:00Z",
"description": "Follow-up session",
"modifiers": [
  "Extended",
  "Emergency"
],
"price": 50,
"service_code": "SVC002",
"units": 2,
"units_decimal": 2
}
]
]
```

**items.map(x, x.units\_decimal)** `[]float64 (double)` *required*

Mapped array of: Number of units

```json CEL theme={null}
$result_object_key.items.map(x, x.units_decimal)
```

```json Example theme={null}
[
2
]
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.