Shared types are used where the same structure of data appears in more than one data type.
Reference date types (ending with Ref) link between data types in the Railz Accounting API endpoints.
AccountRef
Links to the accounts data type.
Financial Statements
While financial statements do not have an
accountRefobject, they do haveaccountIdandsubAccountIdfields on each line which can be used to link to the accounts data type.
Xero Specific Rules
When pushing invoices to Xero,
accountRefis required if noinventoryRefis used.
Found on:
- Accounting Transactions
- Bank Transactions
- Bills
- Bill Credit Notes
- Bill Payments
- Deposits
- Estimates
- Expenses
- Inventory
- Invoices
- Invoice Credit Notes
- Invoice Payments
- Journal Entries
- Purchase Orders
- Refunds
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the account in the accounting service provider. |
| name | string | Name of the account in the accounting service provider. |
"accountRef": {
"id": "150",
"name": "Advertising Expenses"
}
Address
Found on:
| Field | Type | Description |
|---|---|---|
| type | string | Type of the address.billingshipping other |
| line1 | string | Line 1 of the billing address. |
| line2 | string | Line 2 of the billing address.. |
| city | string | City of the billing address. |
| region | string | Region of the billing address. |
| country | string | Country of the billing address as 3 ISO alpha-3 characters. |
| postalCode | string | Postal code or zip code of the billing address. |
{
"type": "Shipping",
"line1": "St Peter's Rd",
"line2": "Suite 200",
"city": "Cambridgeshire",
"region": "West Land",
"country": "CAN",
"postalCode": "P3E7D9"
}
Contact
Found on:
| Field | Type | Description |
|---|---|---|
| name | string | Name of a contact |
| string | Email of a contact | |
| phone | string | Phone of a contact |
| address | array | An array of addresses. |
| status | string | Status of a contact.unknownactivearchived |
{
"name": "James Smith",
"email": "[email protected]",
"phone": "18004567890",
"addresses":
[
{
"type": "billing",
"line1": "St Peter's Rd",
"line2": "Suite 200",
"city": "Cambridgeshire",
"region": "West Land",
"country": "CAN",
"postalCode": "P3E7D9"
}
],
"status": "active",
}
CustomerRef
Links to the Customers data type.
Found on:
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the customer in the accounting service provider. |
| name | string | Name of the customer in the accounting service provider. |
"customerRef": {
"id": "120",
"name": "ABC Inc."
}
EntityRef
Depending on context, may link to the Customers or Vendors data type.
Found on:
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the customer/vendor in the accounting service provider. |
| name | string | Name of the customer/vendor in the accounting service provider. |
| type | string | Type of the Entity in the accounting service provider. It can be: - customer- vendor- unknown |
"entityRef": {
"id": "100",
"name": "ABC Inc",
"type": "customer",
}
entityRef.type can be
customerorvendor.
InventoryRef
Links to the Inventory data type.
Xero Specific Rules
When pushing invoices to Xero,
inventoryRefis required if noaccountRefis used.
Found on:
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the inventory item in the accounting service provider. |
| name | string | Name of the inventory item in the accounting service provider. |
"inventoryRef": {
"id": "10",
"name": "White golf balls"
}
JournalRef
Found on:
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the journal item in the accounting service provider. |
| name | string | Name of the journal item in the accounting service provider. |
"journalRef": {
"id": "32",
"name": "Historical Adjustment"
}
LocationRef
Found on:
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the location in the accounting service provider. |
| name | string | Name of the location in the accounting service provider. |
"locationRef": {
"id": "32",
"name": "United States"
}
ParentRef
Links to the accounts data type.
Found on:
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the account in the accounting service provider. |
| name | string | Name of the account in the accounting service provider. |
"parentRef": {
"id": "4",
"name": "Assets"
}
PaymentMethodRef
Found on:
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the payment method in the accounting service provider. |
| name | string | Name of the payment method in the accounting service provider. |
| type sortable, filterable | string | Type of the payment method in the accounting service provider |
"paymentMethodRef": {
"id": "3",
"name": "Harmonized sales tax",
"type": "creditCard"
}
PurchaseOrderRef
Links to the Purchase Orders data type.
Found on:
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the purchase order in the accounting service provider. |
| purchaseOrderNumber | string | Reference number of the purchase order in the accounting service provider. |
"purchaseOrderRef": {
"id": "10",
"purchaseOrderNumber": "PO-1245"
}
SubsidiaryRef
Found on:
- accounts
- Bill Payments
- Bill Credit Notes
- Bills
- Customers
- Inventory
- Invoices
- Invoices Credit Notes
- Invoice Payments
- Journal Entries
- Tracking Categories
- Trial Balances
- Vendors
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the subsidiary in the accounting service provider. |
| name | string | Name of the subsidiary in the accounting service provider. |
"subsidiaryRef": {
"id": "8",
"name": "Honeywell"
}
TaxRateRef
Links to the Tax Rates data type.
Found on:
- accounts
- Bank Transactions
- Bills
- Bill Credit Notes
- Deposits
- Estimates
- Expenses
- Inventory
- Invoices
- Invoice Credit Notes
- Journal Entries
- Purchase Orders
- Refunds
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the tax rate in the accounting service provider. |
| name | string | Name of the tax rate in the accounting service provider. |
| effectiveTaxRate | decimal | Effective tax rate |
"taxRateRef": {
"id": "15",
"name": "GST/HST"
}
TrackingCategoryRefs
Links to the Tracking Categories data type.
Found on:
- Accounting Transactions
- Bank Transactions
- Bills
- Bill Credit Notes
- Estimates
- Expenses
- Invoices
- Invoice Credit Notes
- Journal Entries
- Purchase Orders
- Refunds
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the tracking category in the accounting service provider. |
| name | string | Name of the tracking category in the accounting service provider. |
| type sortable, filterable | string | Type of the tracking category in the accounting service provider |
"trackingCategoryRefs": {
"id": "4040",
"name": "Region",
"type": "Class"
}
VendorRef
Links to the Vendors data type.
Found on:
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier for the vendor in the accounting service provider. |
| name | string | Name of the vendor in the accounting service provider. |
"vendorRef": {
"id": "120",
"name": "ABC Inc."
}