Query Invoices activity

An activity that retrieves one or more invoices from Stripe.

Configure the Query Invoices activity

Examples

(External) AgilePoint NX Connector For Stripe
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Stripe tab.
On the Stripe tab, drag the Query Invoices activity onto your process.

General Configuration

Specifies the basic settings for the Query Invoices activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Query Invoices Configuration

Specifies the information about one or more invoices to retrieve from Stripe.

Fields

Field Name	Definition
Stripe	Description: Specifies the access token that connects to your Stripe service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for Stripe Function of this Screen: Configure an access token to connect to Stripe.
By Invoice ID / Filter Condition	Description: Specifies whether to retrieve information about one or more invoices with an invoice ID or a SQL WHERE clause. Allowed Values: By Invoice ID - Retrieves information for an invoice with an invoice ID. Filter Condition - Retrieves information about one or more invoices with a SQL WHERE clause. Default Value: By Invoice ID Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Invoice ID	Description: Specifies the ID of the invoice whose information to retrieve. Allowed Values: An invoice ID from Stripe. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Map Response To App Schema	Description: Maps information about the invoice from the Stripe data model to your process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper screen. Use this screen to connect the request to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper

Query Invoices Configuration > Where tab

Specifies how to configure a filter condition for your query.

Fields

Field Name	Definition
Stripe	Description: Specifies the access token that connects to your Stripe service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for Stripe Function of this Screen: Configure an access token to connect to Stripe.
By Invoice ID / Filter Condition	Description: Specifies whether to retrieve information about one or more invoices with an invoice ID or a SQL WHERE clause. Allowed Values: By Invoice ID - Retrieves information for an invoice with an invoice ID. Filter Condition - Retrieves information about one or more invoices with a SQL WHERE clause. Default Value: By Invoice ID Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Enter Filter Condition / Build Filter Condition	Description: Specifies how to configure a filter condition for your query. Allowed Values: Enter Filter Condition – Specifies a SQL WHERE clause to retrieve information about one or more invoices from Stripe. The WHERE clause must be in the syntax specified by Stripe. For more information, refer to https://stripe.com/docs. Build Filter Condition – Shows the SQL code snippet that is created when you configure the filter condition for your query. You can configure the filter condition on the Query Invoices Configuration > Where tab > Create Conditions screen. Default Value: Build Filter Condition Accepts Variables: No Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Code Snippet	Description: Shows the SQL code snippet that is created when you configure the filter condition for your query. You can configure the filter condition on the Query Invoices Configuration > Where tab > Create Conditions screen. Allowed Values: Read only. Default Value: None
Create	Opens this Screen: Query Invoices Configuration > Where tab > Create Conditions Function of this Screen: Specifies a filter condition to retrieve information about one or more invoices from Stripe.
Delete	Function: Deletes the query from the code snippet.
Edit	Function: Lets you change the query.

Query Invoices Configuration > Where tab > Create Conditions

Specifies a filter condition to retrieve information about one or more invoices from Stripe.

Fields

Field Name	Definition
Add expression	Function: Creates a condition row.
Delete	Function: Deletes the condition row.
Select Nest Type	Function: Specifies the use of logical AND and OR operators to nest conditions to filter invoices. You must set the condition first, before you specify the nest type. Allowed Values: And - Specifies the logical AND operator. Or - Specifies the logical OR operator. Default Value: AND
Column	Description: Specifies the name of the column from Stripe to use in your query. Allowed Values: A column name from the list. When you select the access token from the Stripe field, this field shows the column names associated with the access token. Default Value: None Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Comparer	Description: Specifies the operator to use in your query. Allowed Values: is equal to is not equal to is less than is less than or equal to is greater than is greater than or equal to is blank contains does not contain Default Value: is equal to
Value	Description: Specifies the value for the column. Allowed Values: A valid column value. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Back	Function: Saves the rule and goes back to the Query Invoices Configuration screen.

Query Invoices Configuration > Response tab

Specifies how to store the information about one or more invoices from Stripe to your process schema.

Fields

Field Name	Definition
Stripe	Description: Specifies the access token that connects to your Stripe service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for Stripe Function of this Screen: Configure an access token to connect to Stripe.
By Invoice ID / Filter Condition	Description: Specifies whether to retrieve information about one or more invoices with an invoice ID or a SQL WHERE clause. Allowed Values: By Invoice ID - Retrieves information for an invoice with an invoice ID. Filter Condition - Retrieves information about one or more invoices with a SQL WHERE clause. Default Value: By Invoice ID Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Map Response To App Schema / Store Response In This Variable	Description: Specifies where to store the response from Stripe. Allowed Values: Store Response To This Variable – Select this option if you want to store the information from Stripe to a variable in the AgilePoint NX app. In the text field, specify a variable that accepts an alphanumeric string in JSON format. Map Response To App Schema – Select this option if you want to map the information from the Stripe data model to your process schema. Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node. Default Value: Map Response To App Schema Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?