Reference Types

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 accountRef object, they do have accountId and subAccountId fields on each line which can be used to link to the accounts data type.

📘

Xero Specific Rules

When pushing invoices to Xero, accountRef is required if no inventoryRef is used.

Found on:

FieldTypeDescription
idstringUnique identifier for the account in the accounting service provider.
namestringName of the account in the accounting service provider.
"accountRef": {
  	"id": "150",
    "name": "Advertising Expenses"
}

Address

Found on:

FieldTypeDescription
typestringType of the address.
billing
shipping
other
line1stringLine 1 of the billing address.
line2stringLine 2 of the billing address..
citystringCity of the billing address.
regionstringRegion of the billing address.
countrystringCountry of the billing address as 3 ISO alpha-3 characters.
postalCodestringPostal 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:

FieldTypeDescription
name stringName of a contact
emailstringEmail of a contact
phone stringPhone of a contact
address arrayAn array of addresses.
status stringStatus of a contact.
unknown
active
archived
{
  "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:

FieldTypeDescription
idstringUnique identifier for the customer in the accounting service provider.
namestringName 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:

FieldTypeDescription
idstringUnique identifier for the customer/vendor in the accounting service provider.
namestringName of the customer/vendor in the accounting service provider.
typestringType 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 customer or vendor.

InventoryRef

Links to the Inventory data type.

📘

Xero Specific Rules

When pushing invoices to Xero, inventoryRef is required if no accountRef is used.

Found on:

FieldTypeDescription
idstringUnique identifier for the inventory item in the accounting service provider.
namestringName of the inventory item in the accounting service provider.
"inventoryRef": {  	
  "id": "10",
  "name": "White golf balls"
}

JournalRef

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the journal item in the accounting service provider.
name stringName of the journal item in the accounting service provider.
"journalRef": {  	
  "id": "32",
  "name": "Historical Adjustment"
}

LocationRef

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the location in the accounting service provider.
name stringName of the location in the accounting service provider.
"locationRef": {  	
  "id": "32",
  "name": "United States"
}

ParentRef

Links to the accounts data type.

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the account in the accounting service provider.
namestringName of the account in the accounting service provider.
"parentRef": {  	
  "id": "4",
  "name": "Assets"
}

PaymentMethodRef

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the payment method in the accounting service provider.
namestringName of the payment method in the accounting service provider.
type
sortable, filterable
stringType 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:

FieldTypeDescription
idstringUnique identifier for the purchase order in the accounting service provider.
purchaseOrderNumberstringReference number of the purchase order in the accounting service provider.
"purchaseOrderRef": {  	
  "id": "10",
  "purchaseOrderNumber": "PO-1245"
}

SubsidiaryRef

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the subsidiary in the accounting service provider.
name stringName of the subsidiary in the accounting service provider.
"subsidiaryRef": {  	
  "id": "8",
  "name": "Honeywell"
}

TaxRateRef

Links to the Tax Rates data type.

Found on:

FieldTypeDescription
idstringUnique identifier for the tax rate in the accounting service provider.
namestringName of the tax rate in the accounting service provider.
effectiveTaxRatedecimalEffective tax rate
"taxRateRef": {
  	"id": "15",
    "name": "GST/HST"
}

TrackingCategoryRefs

Links to the Tracking Categories data type.

Found on:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the tracking category in the accounting service provider.
namestringName of the tracking category in the accounting service provider.
type
sortable, filterable
stringType 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:

FieldTypeDescription
id
sortable, filterable
stringUnique identifier for the vendor in the accounting service provider.
name stringName of the vendor in the accounting service provider.
"vendorRef": {  	
  "id": "120",
  "name": "ABC Inc."
}