96 lines
4.6 KiB
Markdown
96 lines
4.6 KiB
Markdown
# Railz
|
|
|
|
This source can sync data for the [Railz API](https://docs.railz.ai/).
|
|
This page guides you through the process of setting up the Railz source connector.
|
|
|
|
## Prerequisites
|
|
|
|
- A Railz account with permission to access data from accounts you want to sync.
|
|
- Railz Client ID and Secret key
|
|
|
|
## Setup guide
|
|
|
|
### Step 1: Set up Railz
|
|
|
|
Generate API key [on the dashboard](https://dashboard.railz.ai/developers/api-keys) and take it's client_id and secret_key.
|
|
|
|
### Step 2: Set up the source connector in Airbyte
|
|
|
|
<!-- env:cloud -->
|
|
|
|
**For Airbyte Cloud:**
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account;
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**;
|
|
3. On the source setup page, select **Railz** from the Source type dropdown and enter a name for this connector;
|
|
4. Enter `Client ID (client_id)`;
|
|
5. Enter `Secret key (secret_key)`;
|
|
6. Enter `Start date` (optional);
|
|
7. click `Set up source`.
|
|
<!-- /env:cloud -->
|
|
|
|
<!-- env:oss -->
|
|
|
|
**For Airbyte Open Source:**
|
|
|
|
1. Go to local Airbyte page;
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**;
|
|
3. On the source setup page, select **Railz** from the Source type dropdown and enter a name for this connector;
|
|
4. Enter `Client ID (client_id)`;
|
|
5. Enter `Secret key (secret_key)`;
|
|
6. Enter `Start date`;
|
|
7. click `Set up source`.
|
|
<!-- /env:oss -->
|
|
|
|
## Supported sync modes
|
|
|
|
The Railz supports full refresh and incremental sync.
|
|
|
|
| Feature | Supported? |
|
|
| :---------------- | :--------- |
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | Yes |
|
|
|
|
## Supported Streams
|
|
|
|
Several output streams are available from this source:
|
|
|
|
- [Businesses](https://docs.railz.ai/reference/get-businesses)
|
|
- [Connections](https://docs.railz.ai/reference/getconnections)
|
|
- [Customers](https://docs.railz.ai/reference/getcustomers)
|
|
- [Accounts](https://docs.railz.ai/reference/getaccounts)
|
|
- [Inventory](https://docs.railz.ai/reference/getinventory)
|
|
- [Tax Rates](https://docs.railz.ai/reference/gettaxrates)
|
|
- [Tracking Categories](https://docs.railz.ai/reference/get-trackingcategories)
|
|
- [Vendors](https://docs.railz.ai/reference/getvendors)
|
|
- [Bank Accounts](https://docs.railz.ai/reference/get-bankaccounts)
|
|
- [Accounting Transactions](https://docs.railz.ai/reference/get-accountingtransactions) \(Incremental sync\)
|
|
- [Bank Transfers](https://docs.railz.ai/reference/get-banktransfers) \(Incremental sync\)
|
|
- [Bills](https://docs.railz.ai/reference/getbills) \(Incremental sync\)
|
|
- [Bills Credit Notes](https://docs.railz.ai/reference/bill-creditnotes) \(Incremental sync\)
|
|
- [Bills Payments](https://docs.railz.ai/reference/getbillspayments) \(Incremental sync\)
|
|
- [Deposits](https://docs.railz.ai/reference/get-deposits) \(Incremental sync\)
|
|
- [Estimates](https://docs.railz.ai/reference/get-estimates) \(Incremental sync\)
|
|
- [Invoices](https://docs.railz.ai/reference/getinvoices) \(Incremental sync\)
|
|
- [Invoices Credit Notes](https://docs.railz.ai/reference/get-invoice-creditnotes) \(Incremental sync\)
|
|
- [Invoices Payments](https://docs.railz.ai/reference/getinvoicespayments) \(Incremental sync\)
|
|
- [Journal Entries](https://docs.railz.ai/reference/get-journalentries) \(Incremental sync\)
|
|
- [Purchase Orders](https://docs.railz.ai/reference/get-purchaseorder) \(Incremental sync\)
|
|
- [Refunds](https://docs.railz.ai/reference/get-refund) \(Incremental sync\)
|
|
- [Commerce Disputes](https://docs.railz.ai/reference/dispute) \(Incremental sync\)
|
|
- [Commerce Orders](https://docs.railz.ai/reference/order) \(Incremental sync\)
|
|
- [Commerce Products](https://docs.railz.ai/reference/product) \(Incremental sync\)
|
|
- [Commerce Transactions](https://docs.railz.ai/reference/transactions) \(Incremental sync\)
|
|
|
|
If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose)
|
|
|
|
### Performance considerations
|
|
|
|
The Railz connector should gracefully handle Railz API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------------------------------------------------|
|
|
| 0.1.1 | 2023-02-16 | [20960](https://github.com/airbytehq/airbyte/pull/20960) | New Source: Railz |
|