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
type stringType of the address, either:
billing
shipping
other
line1 stringLine 1 of the address.
line2 stringLine 2 of the address.
city stringCity of the address.
region stringRegion of the address.
country stringCountry of the address as 3 ISO alpha-3 characters.
postalCode stringPostal code or zip code of the address.
{
  "type": "billing",
  "line1": "St Peter's Rd",
  "line2": "Suite 200",
  "city": "Cambridgeshire",
  "region": "West Land",    
  "country": "CAN",
  "postalCode": "P3E7D9"
}

Contact

Found on:

FieldTypeDescription
name stringContact Name.
phone arrayAn array of phone numbers.
address arrayAn array of addresses.
status stringContact status. Can be:
unknown
active
archived
modifiedDate string
See Date
Date the record was last changed in the accounting service provider.
{
  "name": "James Smith",
  "phone": "18004567890",
  "addresses":
  [
    {
      "type": "billing",
      "line1": "St Peter's Rd",
      "line2": "Suite 200",
      "city": "Cambridgeshire",
      "region": "West Land",
      "country": "CAN",
      "postalCode": "P3E7D9"
    }
  ],
  "status": "active",
  "modifiedDate": "2020-10-30T00:00:00.000Z"
}

CurrencyRef

Found on:

FieldTypeDescription
idstringUnique identifier for the currency in the accounting service provider.
namestringName of the customer in the accounting service provider.

📘

Using Currency Reference in Push

For convenience, when pushing data currencyRef can be used alone with the id as a value instead of nesting it within.

"currencyRef": {
    "id": "CAD",
    "name": "Canadian Dollar"
}

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:

"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"
}

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.

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"
}

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.
"taxRateRef": {
    "id": "15",
    "name": "GST/HST"
}

TrackingCategoryRef

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.
optionstringThe name of the tracking category option in the accounting service provider.
optionIdstringUnique identifier for the tracking category options in the accounting service provider.
"trackingCategoryRef": {
  "id": "4040",
  "name": "Region",
  "option": "East",
  "optionId": "40401"
}

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."
}