Skip to content

Commit

Permalink
Merge pull request invopop#13 from invopop/app_update
Browse files Browse the repository at this point in the history
Update docs with Apps instead of modules
  • Loading branch information
juanmoliner authored Jul 2, 2024
2 parents 568d622 + 7eba271 commit 9135f1f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@
]
},
{
"group": "Modules",
"pages": ["quick-start/modules/chargebee"]
"group": "Apps",
"pages": ["quick-start/apps/chargebee"]
}
]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,39 @@ title: "Chargebee"
description: Import and process invoices and credit notes from Chargebee
---

Invopop's Chargebee module lets you import invoices and credit notes from Chargebee and process them with a workflow in Invopop. This allows you to automatically transform, process and publish your invoices and credit notes to comply with local regulations and integrate with other systems.
Invopop's Chargebee app lets you import invoices and credit notes from Chargebee and process them with a workflow in Invopop. This allows you to automatically transform, process and publish your invoices and credit notes to comply with local regulations and integrate with other systems.

## How it works

Once [set up](#how-to-set-up), the module listens to events from Chargebee. When an invoice is generated (i.e. created and not in the pending state) or when a credit note is created, the module will create a new GOBL invoice and add it to your Invopop account. It will then create a job to process the GOBL invoice using the workflow of your choice.
Once [set up](#how-to-set-up), the app listens to events from Chargebee. When an invoice is generated (i.e. created and not in the pending state) or when a credit note is created, the app will create a new GOBL invoice and add it to your Invopop account. It will then create a job to process the GOBL invoice using the workflow of your choice.

## How to set up

This guide assumes that you already have a Chargebee account configured to generate invoices and credit notes in the country where you operate. Please refer to the Chargebee documentation on how to do this.
This guide assumes that you already have a Chargebee account configured. Otherwise, please refer to the Chargebee documentation on how to do this.

### 1. Enter supplier details

First, you need to set up a supplier in Invopop to use when generating GOBL invoices from Chargebee. In the console, go to "Contacts" > "Suppliers". There you can create a new one with the details (name, tax code, address, etc.) of the company that will issue the invoices. The required data and [extensions](#5-enter-extension-data) depend on the [tax regime](https://github.com/invopop/gobl/tree/main/regimes). Please do not hesitate to contact Invopop support for assistance.
First, you need to set up a supplier in Invopop, containing your business details. In the console, go to "Contacts" > "Suppliers" and click on "New supplier", an add your details (name, tax code, address, etc.). The required data and [extensions](#5-enter-extension-data) depend on the [tax regime](https://github.com/invopop/gobl/tree/main/regimes). Please do not hesitate to contact Invopop support for assistance.

Note that when generating invoices, the module will merge the supplier information in Invopop with the business profile data in Chargebee when issuing the invoice, giving precedence to the data from Chargebee.
Note that when generating invoices, the app will merge the supplier information in Invopop with the business profile data in Chargebee when issuing the invoice, giving precedence to the data from Chargebee.

### 2. Prepare a workflow

Now, you need to set up the workflow in Invopop to process the invoices imported from Chargebee. Go to "Configure" > "Workflows" in the Invopop console and create a workflow.

The workflow should include the steps to convert and publish invoices as local regulations require. You can also add steps for any other automation you want to perform, such as emailing the invoices or storing them in a cloud service.

Be sure to add a "Chargebee" step at the end of the workflow to report back to Chargebee once the document has been processed.
Be sure to add a "Sync with Chargebee" step at the end of the workflow to report back to Chargebee once the document has been processed.

### 3. Connect the Chargebee module
### 3. Connect the Chargebee app

You are now ready to connect and configure the Chargebee module itself. Go to "Configure" > "Modules" in the Invopop console. Then click on "Connect" and "Configure". You'll see a form with the following fields:
You are now ready to connect and configure the Chargebee app itself. Go to "Configure" > "apps" in the Invopop console. Then click on "Connect" and "Configure". You'll see a form with the following fields:

* **Chargebee Site:** The identifier of your Chargebee site. You can find it in the URL when you log in to Chargebee.
* **Chargebee API Key:** The API key used to access Chargebee. Go to "Settings" > "Configure Chargebee" > "API Keys" in the Chargebee UI to create one.
* **Supplier:** The supplier who will be issuing the invoices. You can select the one you created earlier.
* **Workflow:** The workflow that will process the invoices. You can select the one you created earlier.
* **Ignore Chargebee's invoice codes:** If true, the module will ignore the invoice numbers set by Chargebee and let the workflow assign them instead.
* **Ignore Chargebee's invoice codes:** If true, the app will ignore the invoice numbers set by Chargebee and let the workflow assign them instead.

Some countries require specific codes set on tax-exempt invoices. If you're in one of these countries, you'll see the following fields:

Expand Down Expand Up @@ -67,4 +67,4 @@ In the case of custom fields, you must first create them in "Settings" > "Config

### Setup is complete

You are now ready to start importing invoices and credit notes from Chargebee. The module will automatically create GOBL invoices and add them to your Invopop account. The invoices will then be processed using the workflow you set up.
You are now ready to start importing invoices and credit notes from Chargebee. The app will automatically create GOBL invoices and add them to your Invopop account. The invoices will then be processed using the workflow you set up.

0 comments on commit 9135f1f

Please sign in to comment.