Accounting software integrationsBeta
Let your users automatically synchronize their transactions, fees, refunds, payouts, customers, and products with their accounting software.
Integrate with Connect embedded components
Set up Connect.js to enable the ability to add connected account dashboard functionality to your website.
Select the app to integrate
Stripe supports the following accounting app integrations.
Accounting App integration | App ID |
---|---|
QuickBooks Sync by Acodei | com.example.acodeistripeapp |
Xero sync by Xero | com.xero.stripeapp |
Set up app installation
Render the app install embedded component for your selected accounting app. App installation grants permission for the third party app to access your users’ Stripe data, creating a connection between your platform, Stripe, and the third party app. The component has two states: uninstalled
and installed
. Listen to install event triggers to build your custom UX flow or make updates in your own backend.
When creating an Account Session, enable payments by specifying app_onboarding
, app_install
, and app_settings
in the components
parameter.
After creating the account session and initializing ConnectJS, you can render the app_install component in the front end:
This embedded component supports the following parameters:
Set up app settings
Render the app settings embedded component for your selected accounting app to enable core app functionality including connection to the accounting software account with OAuth, onboarding, settings, and configuration of the service and synchronization states of transactions. Pass the user_id
(business represented on your platform) as an optional HTML attribute that third party apps can use to build a dynamic URL that redirects back to your user dashboard after OAuth.
This component supports the following optional attributes:
Attribute | Description |
---|---|
app | App ID of embedded app, provided by Stripe |
user-id | Unique identifier of the platform user |
Customize for Connect Destination OBO
Pass required and optional transaction data to Xero or QuickBooks Sync by Acodei by updating the destination charge on the connected account using the data standardized data schema below. You must pass a customer object to the destination charge. QuickBooks Sync by Acodei also requires charge updates with refund amounts written to metadata. There are three instances that require you to update your destination charge:
- one-time payment complete
- recurring payment complete
- payment refunded
Field or key name | Format (standard CSV rules apply) | Description |
---|---|---|
charges.customer | string (ID) | Stripe Customer ID (belonging to connected account) attached to a destination charge object. Transactions don’t sync to Apps (such as Xero and QBO) if this field isn’t present. |
customer.name | string | Customer’s full name |
customer.email | string | Customer’s email address |
customer.address.<> | string (multi-field) | Customer’s physical address (can be used for both billing and shipping) |
charges.metadata.[refund_amount] | string (cents integer) | mirroring charges.amount_refunded |
charges.metadata.[refund_reason] | string | reason for the refund |
charges.metadata.[currency_converted] | true | false | null | Set to true if currency has been converted, for example, if the presentment currency differs from the settlement currency. |
customer.metadata.[platform_customer_ID] | string | Customer ID as recorded in the platform’s system |
charges.metadata.[platform_product_ID] | string, CSV multiple products | Product IDs as recorded in the platform’s system, related to this transaction (charge) |
charges.metadata.[platform_product_name] | string, CSV multiple products | Product name as recorded in the platform’s system, related to this transaction (charge) |
charges.metadata.[platform_product_value] | string, CSV multiple products | The individual Product value (price/cost) corresponding to the Product ID and name |
charges.metadata.[platform_order_ID] | string | Order ID as recorded in the platform’s system, related to this transaction (charge) |
charges.metadata.[platform_charge_ID] | string | Charge or transaction ID as recorded in the platform’s system and visible to the merchant |
charges.metadata.[fees_names] | string, CSV | Name of fees merchant is paying (expense) of any kind related to the transaction that aren’t captured in the Charge eg. credit processing fee, platform fee Note: if this field is populated, charges.application_fee is ignored. |
charges.metadata.[fees_values] | string, CSV | Values of fees merchant is paying (expense) of any kind related to the transaction that aren’t captured in the Charge eg. credit processing fee, platform fee |
The following code snippet example traverses to the target destination charge and shows how to update per schema.
- Trace from the Transaction to the destination charge
const paymentOnPlatform = await StripeClient.paymentIntents.retrieve( "pi_3N6JL7LirQdaQn8E1Lpn7Dui", ); const latestCharge = await StripeClient.charges.retrieve( paymentOnPlatform.latest_charge as string, ); const transfer = await StripeClient.transfers.retrieve( latestCharge.transfer as string, ); const payment = await StripeClient.charges.retrieve( transfer.destination_payment as string, undefined, { stripeAccount: transfer.destination as string, }, );
- Create a customer and then update the charge with the relevant customer ID and metadata. The customer must belong to the connected account and not the platform for the data to pass and apps to synchronize.
const customer = await StripeClient.customers.create( { email: `jenny.rosen@example.com`, name: "Jenny Rosen", address.city: "Brothers" Address.state: "Oregon" address.country: "USA" address.line1: "27 Fredrick Ave" address.postal_code: "97712" metadata: { platform_customer_ID: "K-123456" }, }, { stripeAccount: accountId, }, ); const payment = await StripeClient.charges.update( id, { customer: customer.id, metadata: { product_name: "Creative writing course for PMs", platform_product_ID: "P-123456" platform_order_ID: "O-123456" }, }, { stripeAccount: accountId, }, );
Direct charges
The embedded accounting integrations accesses all payment, customer, and product data stored with Stripe. You can pass optional platform-specific data to the accounting software through the App using the below metadata schema.
Field or key name | Format (standard CSV rules apply) | Description |
---|---|---|
customer.metadata.[platform_customer_ID] | string | Customer ID as recorded in the platform’s system |
payment.metadata.[platform_product_ID] | string, CSV multiple products | Product IDs as recorded in the platform’s system, related to this transaction, if different than the Stripe product ID |
payment.metadata.[platform_product_name] | string, CSV multiple products | Product or service names as recorded in the platforms’ system, related to this transaction, if different than the Stripe product name |
payment.metadata.[platform_product_value] | string, CSV multiple products | The individual product value (price or cost) corresponding to the ID and name array, if different than the Stripe product value |
payment.metadata.[platform_order_ID] | string | Order ID as recorded in the platform’s system, related to this transaction (charge) |
payment.metadata.[platform_charge_ID] | string | Charge or transaction ID as recorded on the platform and visible to the user, if different than the Stripe payment ID |
User billing
The Xero App is free for the platforms’ users. The QuickBooks Sync by Acodei includes free and paid tiers.
Other integrations
If you need an integration with other accounting software or any other integration types, reach out at stripe-apps@stripe.com.