Railz
This source can sync data for the Railz API. 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 and take it's client_id and secret_key.
Step 2: Set up the source connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account;
- In the left navigation bar, click Sources. In the top-right corner, click + new source;
- On the source setup page, select Railz from the Source type dropdown and enter a name for this connector;
- Enter
Client ID (client_id)
; - Enter
Secret key (secret_key)
; - Enter
Start date
(optional); - click
Set up source
.
For Airbyte Open Source:
- Go to local Airbyte page;
- In the left navigation bar, click Sources. In the top-right corner, click + new source;
- On the source setup page, select Railz from the Source type dropdown and enter a name for this connector;
- Enter
Client ID (client_id)
; - Enter
Secret key (secret_key)
; - Enter
Start date
; - click
Set up source
.
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
- Connections
- Customers
- Accounts
- Inventory
- Tax Rates
- Tracking Categories
- Vendors
- Bank Accounts
- Accounting Transactions (Incremental sync)
- Bank Transfers (Incremental sync)
- Bills (Incremental sync)
- Bills Credit Notes (Incremental sync)
- Bills Payments (Incremental sync)
- Deposits (Incremental sync)
- Estimates (Incremental sync)
- Invoices (Incremental sync)
- Invoices Credit Notes (Incremental sync)
- Invoices Payments (Incremental sync)
- Journal Entries (Incremental sync)
- Purchase Orders (Incremental sync)
- Refunds (Incremental sync)
- Commerce Disputes (Incremental sync)
- Commerce Orders (Incremental sync)
- Commerce Products (Incremental sync)
- Commerce Transactions (Incremental sync)
If there are more endpoints you'd like Airbyte to support, please create an issue.
Performance considerations
The Railz connector should gracefully handle Railz API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Reference
Config fields reference
Field
Type
Property name
string
client_id
string
secret_key
string
start_date
Changelog
Expand to review
Version | Date | Pull Request | Subject |
---|---|---|---|
0.1.10 | 2024-08-24 | 44649 | Update dependencies |
0.1.9 | 2024-08-17 | 44206 | Update dependencies |
0.1.8 | 2024-08-12 | 43801 | Update dependencies |
0.1.7 | 2024-08-10 | 43541 | Update dependencies |
0.1.6 | 2024-08-03 | 43288 | Update dependencies |
0.1.5 | 2024-07-27 | 42674 | Update dependencies |
0.1.4 | 2024-07-20 | 40029 | Update dependencies |
0.1.3 | 2024-07-19 | 42125 | Fix Python MRO bug |
0.1.2 | 2024-05-21 | 38545 | [autopull] base image + poetry + up_to_date |
0.1.1 | 2023-02-16 | 20960 | New Source: Railz |