Reference types
Reference types link between data types in the Codat accounting data model.
accountRef
Links to the Accounts data type.
Financial Reports
Profit & Loss and Balance Sheet reports do not have an
accountRefobject but do have anaccountIdfield on each line which can be used to link to theaccountsdata type
Found on:
"accountRef": {
"id": "string", // 'id' from the Accounts data type
"name": "string" // 'name' from the Accounts data type
}
billRef
Links to the Bills data type.
Found on:
"billRef": {
"id": "string", // 'id' from the Bills data type
"reference": "string" // 'reference' from the Bills data type
},
contactRef
Links to the Transfers data type.
"contactRef": {
"id": "ddcf351f-c931-46fb-b6d9-e53cbf238847",
"dataType": "customers"
},
customerRef
Links to the Customers data type.
Found on:
"customerRef": {
"id": "string", // 'id' from the 'customers' data type
"companyName": "string" // 'customerName' from the 'customer' data type
}
itemRef
Links to the Items data type.
Found on:
"itemRef": {
"id": "string", // 'id' from the 'items' data type
"name": "string" // 'name' from the 'items' data type
}
paymentMethodRef
Links to the Payment Method data type.
Found on bill payments.
"paymentMethodRef": {
"id": "string", // 'id' from the 'paymentMethods' data type
"name": "string" // 'name' from the 'paymentMethods' data type
}
recordRef
Links a journal entry to the underlying record or data type.
Found on journal entries.
"recordRef": {
"id": "string", // 'id' of the underlying record or data type
"dataType": "string" // Name of the 'dataType'
}
supplierRef
Links to the Suppliers data type.
Found on:
"supplierRef": {
"id": "string", // 'id' from the 'suppliers' data type
"supplierName": "string" // 'supplierName' from the 'suppliers' data type
}
taxRateRef
Links to the Tax Rates data type.
Found on:
- Invoice line items
- Bill line items
- Credit Note line items
- Bill Credit Note line items
- Items
"taxRateRef": {
"id": "string", // 'id' from the 'taxRates' data type
"name": "string", // 'name' from the 'taxRates' data type
"effectiveTaxRate": "decimal" // applicable tax rate
}
trackingCategoryRef
Links to the Tracking Categories data type.
Found on:
"trackingCategoryRef": {
"id": "string", // 'id' from the 'trackingCategories' data type
"name": "string" // 'name' from the 'trackingCategories' data type
}
Updated 6 days ago