{
  "$result_object_key":  {
    "appointment_id":  "12345",
    "cms1500_id":  "12345",
    "details":  "Follow-up Session",
    "id":  "12345",
    "invoice_id":  "12345",
    "invoice_type":  "appointment",
    "is_preview":  false,
    "notes":  "Please see attached the invoice for your session.",
    "price":  123.456,
    "recipient_id":  "12345",
    "sender_id":  "12345",
    "service_date":  "2024-04-22T09:00:00-04:00",
    "services_provided":  "No-Show",
    "status":  "Not Yet Paid"
  }
}

{
  "$result_object_key":  {
    "appointment_id":  "The ID of the appointment associated with this requested payment",
    "cms1500_id":  "The ID of the CMS1500 to pay for",
    "details":  "The details of the invoice (based off of associated item)",
    "id":  "The unique identifier of the payment",
    "invoice_id":  "The generated invoice ID",
    "invoice_type":  "The type of invoice",
    "is_preview":  "True if the invoice is still in preview mode",
    "notes":  "Extra details on the invoice",
    "price":  "Price of payment requested",
    "recipient_id":  "The ID of the recipient (client)",
    "sender_id":  "The ID of the sender (provider)",
    "service_date":  "The service date",
    "services_provided":  "The services provided",
    "status":  "The status of the request"
  }
}

​
Parameters

​
Action
Parameters
​
Invoice Type
string
required

This field maps to the destination API invoice_type field.

​
Recipient ID
string

ID This field maps to the destination API recipient_id field.

​
Sender ID
string

ID This field maps to the destination API sender_id field.

​
Offering ID
string

This field maps to the destination API offering_id field.

​
CMS1500 ID
string

This field maps to the destination API cms1500_id field.

​
Price
float64 (double)

This field maps to the destination API price field.

​
Notes
string

This field maps to the destination API notes field.

​
Service Date
timing.v1.Timestamp

This field maps to the destination API service_date field.

​
Services Provided
string

This field maps to the destination API services_provided field.

​
Status
string

This field maps to the destination API status field.

​
Is Preview
bool

This field maps to the destination API is_preview field.

​
User Package Selection ID
string

This field maps to the destination API user_package_selection_id field.

{
  "$result_object_key":  {
    "appointment_id":  "12345",
    "cms1500_id":  "12345",
    "details":  "Follow-up Session",
    "id":  "12345",
    "invoice_id":  "12345",
    "invoice_type":  "appointment",
    "is_preview":  false,
    "notes":  "Please see attached the invoice for your session.",
    "price":  123.456,
    "recipient_id":  "12345",
    "sender_id":  "12345",
    "service_date":  "2024-04-22T09:00:00-04:00",
    "services_provided":  "No-Show",
    "status":  "Not Yet Paid"
  }
}

{
  "$result_object_key":  {
    "appointment_id":  "The ID of the appointment associated with this requested payment",
    "cms1500_id":  "The ID of the CMS1500 to pay for",
    "details":  "The details of the invoice (based off of associated item)",
    "id":  "The unique identifier of the payment",
    "invoice_id":  "The generated invoice ID",
    "invoice_type":  "The type of invoice",
    "is_preview":  "True if the invoice is still in preview mode",
    "notes":  "Extra details on the invoice",
    "price":  "Price of payment requested",
    "recipient_id":  "The ID of the recipient (client)",
    "sender_id":  "The ID of the sender (provider)",
    "service_date":  "The service date",
    "services_provided":  "The services provided",
    "status":  "The status of the request"
  }
}

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

​
RequestedPayment
Fetch Action Response Object
​
id
string
required

The unique identifier of the payment

CEL
$result_object_key.id
Example
"12345"
​
appointment_id
string

The ID of the appointment associated with this requested payment

CEL
$result_object_key.appointment_id
Example
"12345"
​
cms1500_id
string

The ID of the CMS1500 to pay for

CEL
$result_object_key.cms1500_id
Example
"12345"
​
invoice_id
string

The generated invoice ID

CEL
$result_object_key.invoice_id
Example
"12345"
​
sender_id
string

The ID of the sender (provider)

CEL
$result_object_key.sender_id
Example
"12345"
​
recipient_id
string

The ID of the recipient (client)

CEL
$result_object_key.recipient_id
Example
"12345"
​
details
string

The details of the invoice (based off of associated item)

CEL
$result_object_key.details
Example
"Follow-up Session"
​
invoice_type
string

The type of invoice

CEL
$result_object_key.invoice_type
Example
"appointment"
​
notes
string

Extra details on the invoice

CEL
$result_object_key.notes
Example
"Please see attached the invoice for your session."
​
price
float64 (double)

Price of payment requested

CEL
$result_object_key.price
Example
123.456
​
service_date
timing.v1.Timestamp

The service date

CEL
$result_object_key.service_date
Example
"2024-04-22T09:00:00-04:00"
​
services_provided
string

The services provided

CEL
$result_object_key.services_provided
Example
"No-Show"
​
status
string
required

The status of the request

CEL
$result_object_key.status
Example
"Not Yet Paid"
​
is_preview
bool
required

True if the invoice is still in preview mode

CEL
$result_object_key.is_preview
Example
false