Codat · Schema

Record reference

Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.

Unified_API

Properties

Name Type Description
id string 'id' of the underlying record or data type.
dataType string Allowed name of the 'dataType'.
View JSON Schema on GitHub

JSON Schema

codat-accountingrecordref-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountingRecordRef",
  "title": "Record reference",
  "type": "object",
  "x-internal": true,
  "description": "Links the current record to the underlying record or data type that created it. \n\nFor example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ",
  "properties": {
    "id": {
      "type": "string",
      "description": "'id' of the underlying record or data type."
    },
    "dataType": {
      "type": "string",
      "description": "Allowed name of the 'dataType'.",
      "examples": [
        "journalEntry",
        "invoice",
        "accountTransaction",
        "transfer"
      ]
    }
  }
}