Skip to main content
Open a resource to inspect its fields. Required describes a valid resource when it exists; it does not guarantee that a provider supplies the value. Examples are illustrative. A blank source example is shown as “Not specified.” Resource prefixes are documentation context. For example, bank_transaction.amount.amount means data.amount.amount in a bank transaction record. Common metadata is inherited at the same object level.

Platform

common.id

F0001 · id · Required · Nullable: NoStable identifier scoped to the client tenant.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Never use a provider ID as the public primary key.
  • Source families: AMLOK
  • Example: res_01JAMLOK

common.object

F0002 · string · Required · Nullable: NoResource type corresponding to the Entities tab.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: bank_account

common.subject_id

F0003 · id · Optional · Nullable: YesBusiness or person to which this record relates.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Null for tenant-level configuration and unresolved subjects.
  • Source families: AMLOK
  • Example: biz_01JAMLOK

common.created_at

F0004 · datetime · Required · Nullable: NoTime AMLOK first stored this resource.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

common.updated_at

F0005 · datetime · Required · Nullable: NoTime the normalized representation last changed.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

common.observed_at

F0006 · datetime · Optional · Nullable: YesTime the source was observed by AMLOK.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not imply this is the economic event time.
  • Source families: AMLOK
  • Example: Not specified

common.effective_at

F0007 · datetime · Optional · Nullable: YesTime the source states this version became valid.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

common.record_version

F0008 · integer · Required · Nullable: NoMonotonically increasing AMLOK version for this resource.
  • Format / enum / units: JSON integer
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: 3

common.deleted_at

F0009 · datetime · Optional · Nullable: YesTombstone timestamp for a source or AMLOK deletion.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Null for records not deleted; retain only under the configured policy.
  • Source families: AMLOK
  • Example: null

common.source_refs[]

F0010 · array<SourceRef> · Required · Nullable: NoEvidence references contributing to this record.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: A known empty array is valid for a newly client-created record.
  • Source families: AMLOK
  • Example: []

common.field_provenance[]

F0011 · array<FieldProvenance> · Optional · Nullable: YesField-level source, extraction, transformation and quality details.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: []

common.data_status

F0012 · enum:data_status · Required · Nullable: NoWhether the requested resource is complete for its stated scope.
  • Format / enum / units: Enum: data_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Completeness is relative to declared fields, sources and time interval.
  • Source families: AMLOK
  • Example: partial

common.missing_fields[]

F0013 · array<MissingField> · Required · Nullable: NoUnavailable field paths and their explicit reasons.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: []

common.schema_version

F0014 · string · Required · Nullable: NoContract version used to serialize this record.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: 1.4.2

common.client_reference

F0015 · string · Optional · Nullable: YesOptional caller-owned correlation identifier.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Scoped to tenant; uniqueness only when explicitly contracted.
  • Source families: AMLOK
  • Example: app-1029

common.extensions

F0016 · JSON · Optional · Nullable: YesNamespaced extra provider fields without changing the core schema.
  • Format / enum / units: Typed extension object; never credentials
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Access-controlled and documented per provider; no provider tokens.
  • Source families: AMLOK
  • Example: {}

connection.provider_id

F0017 · string · Required · Nullable: NoIntegration catalog identifier.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: BANK-02

connection.provider_tenant_id

F0018 · string · Optional · Nullable: YesOpaque external organization or item identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: item_example

connection.status

F0019 · enum:connection_status · Required · Nullable: NoCurrent connection usability.
  • Format / enum / units: Enum: connection_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: active

connection.institution_id

F0020 · string · Optional · Nullable: YesProvider-specific institution identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: ins_example

connection.institution_name

F0021 · string · Optional · Nullable: YesInstitution display name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: Example Bank

connection.country

F0022 · string · Optional · Nullable: YesInstitution country when established.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: CA

connection.products[]

F0023 · array<string> · Required · Nullable: NoData products enabled for this connection.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: ["transactions","balance"]

connection.scopes[]

F0024 · array<string> · Required · Nullable: NoGranted read/write entitlements.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: ["banking:read"]
F0025 · id · Optional · Nullable: YesConsent record authorizing the connection.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: con_01JAMLOK

connection.last_successful_sync_at

F0026 · datetime · Optional · Nullable: YesLatest fully successful retrieval.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: Not specified

connection.next_refresh_at

F0027 · datetime · Optional · Nullable: YesScheduled next refresh if known.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: Not specified

connection.history_available_from

F0028 · date · Optional · Nullable: YesEarliest date actually returned for the selected resource.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not infer from a provider’s maximum advertised history.
  • Source families: All inventory families
  • Example: 2025-10-22

connection.reauth_required_at

F0029 · datetime · Optional · Nullable: YesWhen renewed user authorization became necessary.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: null

connection.error_code

F0030 · string · Optional · Nullable: YesSanitized connection error code.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: reauth_required

connection.sync_cursor

F0031 · string · Optional · Nullable: YesOpaque AMLOK change cursor for authorized synchronization.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Never expose a provider secret or access token.
  • Source families: All inventory families
  • Example: cur_example

sync_job.connection_id

F0042 · id · Required · Nullable: NoConnection being synchronized.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: cnn_01JAMLOK

sync_job.resources[]

F0043 · array<string> · Required · Nullable: NoRequested resource types.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: ["bank_account","bank_transaction"]

sync_job.status

F0044 · enum:sync_status · Required · Nullable: NoIngestion run state.
  • Format / enum / units: Enum: sync_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: partial

sync_job.started_at

F0045 · datetime · Optional · Nullable: YesProcessing start time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: Not specified

sync_job.completed_at

F0046 · datetime · Optional · Nullable: YesCompletion or terminal failure time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: Not specified

sync_job.requested_from

F0047 · date · Optional · Nullable: YesInclusive source date requested.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 2026-09-01

sync_job.requested_to

F0048 · date · Optional · Nullable: YesExclusive source date requested.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 2026-10-01

sync_job.records_added

F0049 · integer · Optional · Nullable: YesNew records accepted.
  • Format / enum / units: JSON integer
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 150

sync_job.records_updated

F0050 · integer · Optional · Nullable: YesExisting records revised.
  • Format / enum / units: JSON integer
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 2

sync_job.records_removed

F0051 · integer · Optional · Nullable: YesTombstones processed.
  • Format / enum / units: JSON integer
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 1

sync_job.coverage_start

F0052 · date · Optional · Nullable: YesEarliest successfully retrieved date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 2026-09-01

sync_job.coverage_end

F0053 · date · Optional · Nullable: YesExclusive end of successfully retrieved interval.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: 2026-10-01

sync_job.errors[]

F0054 · array<Error> · Optional · Nullable: YesPer-resource retrieval or validation failures.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families
  • Example: []

Identity

F0055 · string · Optional · Nullable: YesName recorded as the legal business name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Retain accents and source spelling; normalized matching key is separate.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: Example Manufacturing Inc.

business.trade_names[]

F0056 · array<string> · Optional · Nullable: YesTrading or DBA names separately identified by the source.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not split an unstructured list without evidence.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: ["Example Works"]

business.former_names[]

F0057 · array<string> · Optional · Nullable: YesHistorical legal names explicitly identified by source.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: []

business.registration_number

F0058 · string · Optional · Nullable: YesCompany or registry registration identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve leading zeroes and jurisdiction-specific punctuation.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: REG-EXAMPLE

business.registration_jurisdiction

F0059 · string · Optional · Nullable: YesRegistry jurisdiction for the identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: CA-ON

business.incorporation_country

F0060 · string · Optional · Nullable: YesCountry of formation.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Normalize documented alpha-3 source codes to alpha-2 using a versioned lookup.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: CA

business.incorporation_date

F0061 · date · Optional · Nullable: YesLegal formation date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: 2018-04-09
F0062 · string · Optional · Nullable: YesSource legal form, normalized only where an approved mapping exists.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: corporation
F0063 · enum:legal_status · Optional · Nullable: YesRegistry legal standing category.
  • Format / enum / units: Enum: legal_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Active does not imply solvency or all compliance obligations satisfied.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: active
F0064 · string · Optional · Nullable: YesUnmodified status supplied by the registry.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: Active

business.tax_identifiers[]

F0065 · array<Identifier> · Optional · Nullable: YesJurisdiction-qualified business tax identifiers.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: []

business.lei

F0066 · string · Optional · Nullable: YesLegal Entity Identifier when assigned.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not invent an LEI from a registration number.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: null

business.registered_address

F0067 · Address · Optional · Nullable: YesRegistered office address.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: {"city":"Toronto","country":"CA"}

business.operating_addresses[]

F0068 · array<Address> · Optional · Nullable: YesKnown trading or operating locations.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: []

business.website

F0069 · string · Optional · Nullable: YesBusiness website reported by a source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: https://example.com

business.email

F0070 · string · Optional · Nullable: YesBusiness contact email.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: contact@example.com

business.phone

F0071 · string · Optional · Nullable: YesBusiness contact telephone.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: E.164 when parseable with country context; otherwise preserve raw value.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: +14165550100

business.industry_codes[]

F0072 · array<IndustryCode> · Optional · Nullable: YesClassification codes with explicit taxonomy and version.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: []

business.business_description

F0073 · string · Optional · Nullable: YesSource description of business activity.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: Industrial component fabrication

business.employee_count

F0074 · integer · Optional · Nullable: YesEmployee count reported for the stated observation date.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Registry or source observation; not a live payroll count.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: 35

business.fiscal_year_end

F0075 · string · Optional · Nullable: YesFiscal year-end month and day.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: MM-DD; not a financial statement date.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: 12-31

business.reporting_currency

F0076 · string · Optional · Nullable: YesHome currency of the business accounting system.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: CAD

business.is_registry_sourced

F0077 · boolean · Optional · Nullable: YesWhether the profile came from a registry rather than self-report.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Retain any subsequent user edits in field provenance.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: true

business.registry_retrieved_at

F0078 · datetime · Optional · Nullable: YesWhen registry evidence was obtained.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: Not specified

business.last_annual_return_date

F0079 · date · Optional · Nullable: YesDate of annual corporate return filing when reported.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Distinct from financial accounts and tax return filing dates.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: 2026-04-01

business.ownership_complete

F0080 · boolean · Optional · Nullable: YesWhether the delivered ownership report meets the declared scope.
  • Format / enum / units: JSON boolean
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Null if completeness cannot be established.
  • Source families: AMLOK verification services; ACC; INV; LEND; client
  • Example: false

person.given_name

F0081 · string · Optional · Nullable: YesGiven name as supplied or verified.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: Alex

person.middle_names

F0082 · string · Optional · Nullable: YesMiddle names when present.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: Morgan

person.family_name

F0083 · string · Optional · Nullable: YesFamily name as supplied or verified.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: Example

person.full_name

F0084 · string · Optional · Nullable: YesFull display name preserving local naming conventions.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: Alex Example

person.date_of_birth

F0085 · date · Optional · Nullable: YesBirth date from authorized evidence.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: 1985-02-14

person.nationalities[]

F0086 · array<string> · Optional · Nullable: YesNationality country codes reported by source.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not infer citizenship from address or birthplace.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: ["CA"]

person.residence_country

F0087 · string · Optional · Nullable: YesCurrent country of residence when established.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: CA

person.addresses[]

F0088 · array<Address> · Optional · Nullable: YesAuthorized address observations.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: []

person.email

F0089 · string · Optional · Nullable: YesContact email.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: alex@example.com

person.phone

F0090 · string · Optional · Nullable: YesContact telephone.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: +14165550101

person.tax_identifier_token

F0091 · string · Optional · Nullable: YesVault reference for a permitted tax identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Default responses never include full SIN/SSN.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: tok_example

person.occupation

F0092 · string · Optional · Nullable: YesOccupation provided for the declared workflow.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: Business owner

person.verification_id

F0093 · id · Optional · Nullable: YesMost recent relevant verification session.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not replace historic sessions.
  • Source families: AMLOK verification services; LEND; client; authorized BANK identity
  • Example: ver_01JAMLOK

relationship.from_entity_id

F0094 · id · Required · Nullable: NoEntity at the source of the relationship.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: per_owner

relationship.to_entity_id

F0095 · id · Required · Nullable: NoEntity at the target of the relationship.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: biz_borrower

relationship.relationship_type

F0096 · enum:relationship_type · Required · Nullable: NoMeaning and direction of the link.
  • Format / enum / units: Enum: relationship_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: beneficial_owner

relationship.ownership_ratio

F0097 · decimal · Optional · Nullable: YesExact ownership share when supplied.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Fraction 0 to 1; never convert an ownership band to an exact share.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: 0.25

relationship.ownership_band_min

F0098 · decimal · Optional · Nullable: YesLower bound of an ownership band.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: 0.25

relationship.ownership_band_max

F0099 · decimal · Optional · Nullable: YesUpper bound of an ownership band.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: 0.50

relationship.voting_ratio

F0100 · decimal · Optional · Nullable: YesVoting rights as a share of total rights.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: 0.30

relationship.is_ultimate_owner

F0101 · boolean · Optional · Nullable: YesWhether the source resolves this party as ultimate owner.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: true

relationship.control_description

F0102 · string · Optional · Nullable: YesEvidence of control beyond share ownership.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: Appointment rights

relationship.valid_from

F0103 · date · Optional · Nullable: YesRelationship start date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: 2020-01-01

relationship.valid_to

F0104 · date · Optional · Nullable: YesRelationship end date if known.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: null

relationship.evidence_document_ids[]

F0105 · array<id> · Optional · Nullable: YesDocuments establishing the relationship.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: []

relationship.confidence

F0106 · decimal · Optional · Nullable: YesAMLOK match confidence only when a calibrated model produces it.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: 0 to 1; not a legal ownership determination.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: null

relationship.review_status

F0107 · enum:review_status · Optional · Nullable: YesHuman review of the relationship evidence.
  • Format / enum / units: Enum: review_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; LEND; client; AMLOK
  • Example: not_reviewed

verification.verification_type

F0108 · string · Required · Nullable: NoVerification purpose, such as KYC or KYB.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: kyc

verification.provider_session_id

F0109 · string · Optional · Nullable: YesUpstream session identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: session_example

verification.status

F0110 · enum:verification_status · Required · Nullable: NoNormalized verification state.
  • Format / enum / units: Enum: verification_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve the upstream status and individual check results.
  • Source families: AMLOK verification services; client
  • Example: in_review

verification.raw_status

F0111 · string · Optional · Nullable: YesExact upstream verification status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: In Review

verification.workflow_version

F0112 · string · Optional · Nullable: YesProvider or AMLOK verification configuration version.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: kyc-ca-v1

verification.hosted_url

F0113 · string · Optional · Nullable: YesTime-limited applicant verification link.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Use only provider-approved domains; never persist public credentials.
  • Source families: AMLOK verification services; client
  • Example: https://verify.example.com/session

verification.expires_at

F0114 · datetime · Optional · Nullable: YesSession link or verification expiry, when explicitly defined.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: Not specified

verification.completed_at

F0115 · datetime · Optional · Nullable: YesTime the verification reached its current completed result.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: Not specified

verification.check_ids[]

F0116 · array<id> · Optional · Nullable: YesIndividual checks comprising the result.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: ["chk_id","chk_liveness"]

verification.warnings[]

F0117 · array<string> · Optional · Nullable: YesProvider warnings preserved with context.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: ["document_expired"]

verification.review_reason_codes[]

F0118 · array<string> · Optional · Nullable: YesReasons for required review.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: ["document_mismatch"]

verification.decision_actor_type

F0119 · string · Optional · Nullable: YesWhether the result was automated or manually reviewed.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: human

verification.report_document_id

F0120 · id · Optional · Nullable: YesStored verification report.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: doc_verification

verification.parent_verification_id

F0121 · id · Optional · Nullable: YesParent KYB session for a related person’s check.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services; client
  • Example: ver_parent

verification.processing_context

API contract field · ProcessingContext · RequiredAuthorized parent Insights workflow or paid Signal monitoring period. This stage is included in the product and creates no separate charge.See processing lifecycle and evidence traceability.

verification.stop_reason

API contract field · nullable · RequiredWhy unfinished processing stopped: account cancellation, parent cancellation, or revoked consent. Null when no stop applies.See processing lifecycle and evidence traceability.

verification_check.verification_id

F0122 · id · Required · Nullable: NoVerification containing this check.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: ver_01JAMLOK

verification_check.check_type

F0123 · string · Required · Nullable: NoSpecific feature run by the provider.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: document_authenticity

verification_check.status

F0124 · enum:check_status · Required · Nullable: NoNormalized outcome of this check.
  • Format / enum / units: Enum: check_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: passed

verification_check.raw_status

F0125 · string · Optional · Nullable: YesUnmodified provider result.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: Approved

verification_check.method

F0126 · string · Optional · Nullable: YesDocument, database, biometric, registry or other method.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: document

verification_check.document_id

F0127 · id · Optional · Nullable: YesEvidence document for this check.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: doc_identity

verification_check.document_type

F0128 · string · Optional · Nullable: YesIdentity document type when relevant.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: passport

verification_check.document_number_token

F0129 · string · Optional · Nullable: YesVault reference for document number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: tok_document

verification_check.document_number_masked

F0130 · string · Optional · Nullable: YesMasked identifier safe for the caller’s scope.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: ****1234

verification_check.issuing_country

F0131 · string · Optional · Nullable: YesCountry issuing the identity evidence.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: CA

verification_check.issue_date

F0132 · date · Optional · Nullable: YesDocument issue date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: 2020-01-01

verification_check.expiry_date

F0133 · date · Optional · Nullable: YesDocument expiry date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: 2030-01-01

verification_check.name_match

F0134 · boolean · Optional · Nullable: YesProvider-reported name match result.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Null if not tested; do not derive from overall approval.
  • Source families: AMLOK verification services
  • Example: true

verification_check.date_of_birth_match

F0135 · boolean · Optional · Nullable: YesProvider-reported date-of-birth match result.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: true

verification_check.address_match

F0136 · boolean · Optional · Nullable: YesProvider-reported address match result.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: null

verification_check.liveness_result

F0137 · enum:check_status · Optional · Nullable: YesLiveness feature outcome if run.
  • Format / enum / units: Enum: check_status
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: passed

verification_check.face_match_score

F0138 · decimal · Optional · Nullable: YesProvider-native face match score.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Retain score scale and version; never assume probability.
  • Source families: AMLOK verification services
  • Example: null

verification_check.score_scale

F0139 · string · Optional · Nullable: YesPublished interpretation and range of the provider score.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: provider_defined

verification_check.warnings[]

F0140 · array<string> · Optional · Nullable: YesFeature-specific warnings.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: []

verification_check.checked_at

F0141 · datetime · Optional · Nullable: YesTime the feature executed.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: Not specified

screening_match.verification_id

F0142 · id · Optional · Nullable: YesSession associated with the screening result.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: ver_01JAMLOK

screening_match.screening_type

F0143 · enum:screening_type · Required · Nullable: NoScreening category.
  • Format / enum / units: Enum: screening_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: sanctions

screening_match.list_name

F0144 · string · Optional · Nullable: YesName of the dataset or watchlist.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: Example sanctions list

screening_match.list_record_id

F0145 · string · Optional · Nullable: YesIdentifier in the source dataset.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: entry_example

screening_match.matched_name

F0146 · string · Optional · Nullable: YesName on the potential matching record.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: Alex Example

screening_match.aliases[]

F0147 · array<string> · Optional · Nullable: YesKnown aliases of the source entry.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: []

screening_match.countries[]

F0148 · array<string> · Optional · Nullable: YesJurisdictions associated with the entry.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: ["CA"]

screening_match.match_score

F0149 · decimal · Optional · Nullable: YesSource-native similarity measure.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Scale and algorithm must be supplied; not a guilt probability.
  • Source families: AMLOK verification services
  • Example: null

screening_match.score_scale

F0150 · string · Optional · Nullable: YesScore range and interpretation.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: provider_defined

screening_match.disposition

F0151 · enum:match_disposition · Required · Nullable: NoReview outcome for this potential match.
  • Format / enum / units: Enum: match_disposition
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: unreviewed

screening_match.reason_codes[]

F0152 · array<string> · Optional · Nullable: YesEvidence driving match or review.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: ["name_similarity"]

screening_match.source_url

F0153 · string · Optional · Nullable: YesReference supporting the screening result.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: https://example.com/record

screening_match.listed_on

F0154 · date · Optional · Nullable: YesListing date when supplied.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: 2026-01-10

screening_match.screened_at

F0155 · datetime · Optional · Nullable: YesScreening execution time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: Not specified

screening_match.reviewed_at

F0156 · datetime · Optional · Nullable: YesTime of analyst disposition.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: null

screening_match.reviewer_id

F0157 · id · Optional · Nullable: YesAuthorized reviewer identifier.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK verification services
  • Example: null

document.document_type

F0158 · enum:document_type · Required · Nullable: NoCategory of evidence.
  • Format / enum / units: Enum: document_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: bank_statement

document.file_name

F0159 · string · Optional · Nullable: YesOriginal or normalized file name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: statement-2026-09.pdf

document.mime_type

F0160 · string · Required · Nullable: NoValidated media type.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: application/pdf

document.byte_size

F0161 · integer · Optional · Nullable: YesFile size in bytes.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: 123456

document.sha256

F0162 · string · Optional · Nullable: YesChecksum of the retained evidence bytes.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: sha256_example

document.storage_reference

F0163 · string · Optional · Nullable: YesOpaque controlled evidence reference.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: No permanent public object-store URL.
  • Source families: All inventory families; client uploads
  • Example: evidence_example

document.period_start

F0164 · date · Optional · Nullable: YesFirst date covered by the document.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: 2026-09-01

document.period_end

F0165 · date · Optional · Nullable: YesLast date covered by the document, inclusive.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: 2026-09-30

document.issued_on

F0166 · date · Optional · Nullable: YesIssue date printed on the document.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: 2026-10-01

document.issuer

F0167 · string · Optional · Nullable: YesDocument issuer.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: Example Bank

document.page_count

F0168 · integer · Optional · Nullable: YesNumber of pages.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: 5

document.extraction_status

F0169 · string · Optional · Nullable: YesProcessing state for structured extraction.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: completed

document.extraction_model_version

F0170 · string · Optional · Nullable: YesVersion of parser or extraction model.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: statement-parser-v1

document.extraction_confidence

F0171 · decimal · Optional · Nullable: YesCalibrated extraction quality when available.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: null

document.review_status

F0172 · enum:review_status · Optional · Nullable: YesHuman validation of extracted evidence.
  • Format / enum / units: Enum: review_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: not_reviewed

document.retention_policy_id

F0173 · string · Optional · Nullable: YesApplicable configured retention policy.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: All inventory families; client uploads
  • Example: evidence-policy-v1

document.stop_reason

API contract field · nullable · RequiredWhy unfinished processing stopped: account cancellation, parent cancellation, or revoked consent. Null when no stop applies.See processing lifecycle and evidence traceability.

Banking

bank_account.connection_id

F0175 · id · Required · Nullable: NoAuthorized bank connection.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: cnn_01JAMLOK

bank_account.source_account_id

F0176 · string · Optional · Nullable: YesUpstream account identifier within its connection.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: account_example

bank_account.name

F0177 · string · Optional · Nullable: YesAccount name supplied by institution or holder.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: Operating account

bank_account.official_name

F0178 · string · Optional · Nullable: YesInstitution’s official account product name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: Business chequing

bank_account.account_type

F0179 · enum:account_type · Required · Nullable: NoBroad financial account class.
  • Format / enum / units: Enum: account_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: depository

bank_account.account_subtype

F0180 · string · Optional · Nullable: YesDetailed subtype with preserved raw value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: checking

bank_account.ownership_type

F0181 · enum:account_ownership · Optional · Nullable: YesBusiness, personal, joint or trust classification.
  • Format / enum / units: Enum: account_ownership
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: business

bank_account.institution_name

F0182 · string · Optional · Nullable: YesName of the institution holding the account.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: Example Bank

bank_account.country

F0183 · string · Optional · Nullable: YesInstitution jurisdiction established by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: CA

bank_account.mask

F0184 · string · Optional · Nullable: YesProvider-supplied masked account suffix.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: May be 2 to 4 characters; not a unique key.
  • Source families: BANK
  • Example: 1234

bank_account.currency

F0185 · string · Optional · Nullable: YesCurrency of the account balance.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: CAD

bank_account.holder_names[]

F0186 · array<string> · Optional · Nullable: YesNames returned by an entitled ownership product.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Account ownership data is not automatically a completed KYC check.
  • Source families: BANK
  • Example: []

bank_account.holder_entity_ids[]

F0187 · array<id> · Optional · Nullable: YesResolved AMLOK holders.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: []

bank_account.is_closed

F0188 · boolean · Optional · Nullable: YesExplicit account closure indicator.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Disappearance from an API response alone does not prove closure.
  • Source families: BANK
  • Example: false

bank_account.opened_on

F0189 · date · Optional · Nullable: YesAccount opening date when actually returned.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_account.closed_on

F0190 · date · Optional · Nullable: YesExplicit closure date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_account.bank_identifier

F0191 · string · Optional · Nullable: YesInstitution routing identifier, when entitled.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: 000

bank_account.branch_identifier

F0192 · string · Optional · Nullable: YesBranch or transit identifier, when entitled.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: 00000

bank_account.account_number_token

F0193 · string · Optional · Nullable: YesVault reference for the full account number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Raw account numbers require a separately authorized product and scope.
  • Source families: BANK
  • Example: tok_account

account_balance.account_id

F0194 · id · Required · Nullable: NoAccount for the balance.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK; authorized financial ledger
  • Example: bka_01JAMLOK

account_balance.current.amount

F0195 · decimal · Optional · Nullable: YesCurrent balance reported by the institution. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Positive depository amounts are assets; positive loan/credit amounts normally represent debt.
  • Source families: BANK; authorized financial ledger
  • Example: 1234.56

account_balance.current.currency

F0196 · string · Optional · Nullable: YesCurrency for current.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK; authorized financial ledger
  • Example: CAD

account_balance.available.amount

F0197 · decimal · Optional · Nullable: YesFunds available under the institution’s calculation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK; authorized financial ledger
  • Example: 1234.56

account_balance.available.currency

F0198 · string · Optional · Nullable: YesCurrency for available.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK; authorized financial ledger
  • Example: CAD

account_balance.credit_limit.amount

F0199 · decimal · Optional · Nullable: YesAuthorized credit or overdraft limit where explicitly reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK; authorized financial ledger
  • Example: 1234.56

account_balance.credit_limit.currency

F0200 · string · Optional · Nullable: YesCurrency for credit limit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK; authorized financial ledger
  • Example: CAD

account_balance.balance_basis

F0201 · enum:balance_basis · Required · Nullable: NoWhether current balance represents an asset or liability.
  • Format / enum / units: Enum: balance_basis
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK; authorized financial ledger
  • Example: asset

account_balance.as_of

F0202 · datetime · Optional · Nullable: YesSource balance timestamp if supplied.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Never substitute ingestion time as a source balance timestamp.
  • Source families: BANK; authorized financial ledger
  • Example: Not specified

account_balance.retrieved_at

F0203 · datetime · Required · Nullable: NoAMLOK balance retrieval time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK; authorized financial ledger
  • Example: Not specified

account_balance.is_realtime

F0204 · boolean · Optional · Nullable: YesWhether this observation was retrieved by a verified live-balance route.
  • Format / enum / units: JSON boolean
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Cached account responses are not real-time.
  • Source families: BANK; authorized financial ledger
  • Example: false

account_balance.date_basis

F0205 · enum:balance_date_basis · Required · Nullable: NoHow balance timing was established.
  • Format / enum / units: Enum: balance_date_basis
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK; authorized financial ledger
  • Example: source_observed

bank_transaction.account_id

F0206 · id · Required · Nullable: NoFinancial account carrying the transaction.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: bka_01JAMLOK

bank_transaction.source_transaction_id

F0207 · string · Optional · Nullable: YesProvider transaction identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: txn_provider

bank_transaction.amount.amount

F0208 · decimal · Optional · Nullable: YesAbsolute transaction magnitude. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Nonnegative; direction is separate. Preserve original signed amount in provenance.
  • Source families: BANK
  • Example: 1234.56

bank_transaction.amount.currency

F0209 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK
  • Example: CAD

bank_transaction.direction

F0210 · enum:direction · Required · Nullable: NoMovement into or out of the financial account.
  • Format / enum / units: Enum: direction
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: For Plaid Transactions invert sign semantics; do not apply this rule to Plaid Income.
  • Source families: BANK
  • Example: inflow

bank_transaction.status

F0211 · enum:transaction_status · Required · Nullable: NoPending, posted or removed state.
  • Format / enum / units: Enum: transaction_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: posted

bank_transaction.posted_on

F0212 · date · Optional · Nullable: YesDate the institution posted the transaction.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: For pending transactions leave null if only an occurrence date is known.
  • Source families: BANK
  • Example: 2026-10-21

bank_transaction.authorized_on

F0213 · date · Optional · Nullable: YesDate payment was authorized or initiated.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: 2026-10-20

bank_transaction.occurred_at

F0214 · datetime · Optional · Nullable: YesTimestamp of the transaction event if supplied.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_transaction.description

F0215 · string · Optional · Nullable: YesTransaction description supplied by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: EXAMPLE CUSTOMER PAYMENT

bank_transaction.merchant_name

F0216 · string · Optional · Nullable: YesMerchant or counterparty label supplied by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: Example Customer

bank_transaction.counterparty_id

F0217 · id · Optional · Nullable: YesAMLOK counterparty resolved with evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: pty_example

bank_transaction.category

F0218 · enum:cashflow_category · Optional · Nullable: YesAMLOK cash-flow classification.
  • Format / enum / units: Enum: cashflow_category
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: sales_receipt

bank_transaction.source_category

F0219 · string · Optional · Nullable: YesProvider’s original category label/code.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: TRANSFER_IN

bank_transaction.category_confidence

F0220 · decimal · Optional · Nullable: YesCalibrated classification confidence if available.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_transaction.payment_channel

F0221 · string · Optional · Nullable: YesSource payment channel.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: bank_transfer

bank_transaction.merchant_category_code

F0222 · string · Optional · Nullable: YesReported merchant category code.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Four-character string; not equivalent to NAICS.
  • Source families: BANK
  • Example: null

bank_transaction.pending_transaction_id

F0223 · id · Optional · Nullable: YesEarlier pending record superseded by this posting.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null
F0224 · id · Optional · Nullable: YesMatched internal-transfer pair when established.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_transaction.is_internal_transfer

F0225 · boolean · Optional · Nullable: YesWhether evidence establishes movement between the subject’s own accounts.
  • Format / enum / units: JSON boolean
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Unknown is null, not false.
  • Source families: BANK
  • Example: null

bank_transaction.is_reversal

F0226 · boolean · Optional · Nullable: YesWhether explicitly reversed or linked to a reversing record.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: false

bank_transaction.reverses_transaction_id

F0227 · id · Optional · Nullable: YesOriginal transaction reversed by this one.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_transaction.running_balance.amount

F0228 · decimal · Optional · Nullable: YesSource-reported balance immediately after the transaction. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK
  • Example: 1234.56

bank_transaction.running_balance.currency

F0229 · string · Optional · Nullable: YesCurrency for running balance.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK
  • Example: CAD

bank_transaction.location

F0230 · Address · Optional · Nullable: YesReported physical transaction location.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

bank_transaction.check_number

F0231 · string · Optional · Nullable: YesCheque number where explicitly reported.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK
  • Example: null

recurring_stream.account_id

F0232 · id · Required · Nullable: NoAccount for the recurring stream.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: bka_01JAMLOK

recurring_stream.direction

F0233 · enum:direction · Required · Nullable: NoExpected account movement direction.
  • Format / enum / units: Enum: direction
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: outflow

recurring_stream.description

F0234 · string · Optional · Nullable: YesDescription of the recurring pattern.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: Monthly equipment payment

recurring_stream.counterparty_id

F0235 · id · Optional · Nullable: YesResolved counterparty when available.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: pty_lender

recurring_stream.frequency

F0236 · enum:frequency · Optional · Nullable: YesObserved or provider-reported cadence.
  • Format / enum / units: Enum: frequency
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: monthly

recurring_stream.average_amount.amount

F0237 · decimal · Optional · Nullable: YesAverage amount over the stated observation interval. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK optional products; AMLOK
  • Example: 1234.56

recurring_stream.average_amount.currency

F0238 · string · Optional · Nullable: YesCurrency for average amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK optional products; AMLOK
  • Example: CAD

recurring_stream.last_amount.amount

F0239 · decimal · Optional · Nullable: YesMost recent observed amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK optional products; AMLOK
  • Example: 1234.56

recurring_stream.last_amount.currency

F0240 · string · Optional · Nullable: YesCurrency for last amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK optional products; AMLOK
  • Example: CAD

recurring_stream.first_seen_on

F0241 · date · Optional · Nullable: YesFirst supporting transaction date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: 2026-01-15

recurring_stream.last_seen_on

F0242 · date · Optional · Nullable: YesMost recent supporting transaction date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: 2026-10-15

recurring_stream.next_expected_on

F0243 · date · Optional · Nullable: YesPredicted next occurrence date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: 2026-11-15

recurring_stream.transaction_ids[]

F0244 · array<id> · Optional · Nullable: YesSupporting transaction records.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: ["btx_a","btx_b"]

recurring_stream.is_active

F0245 · boolean · Optional · Nullable: YesWhether the stream remains active under its declared method.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: true

recurring_stream.method_version

F0246 · string · Optional · Nullable: YesProvider or AMLOK pattern method version.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK optional products; AMLOK
  • Example: recurrence-v1

income_observation.person_id

F0247 · id · Optional · Nullable: YesPerson associated with the income evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: per_example

income_observation.income_source

F0248 · string · Optional · Nullable: YesEmployer or other origin reported by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: Example Employer

income_observation.income_type

F0249 · string · Optional · Nullable: YesWages, benefits, business income or other source category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: employment

income_observation.gross_amount.amount

F0250 · decimal · Optional · Nullable: YesGross income before deductions, only when established. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: 1234.56

income_observation.gross_amount.currency

F0251 · string · Optional · Nullable: YesCurrency for gross amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: CAD

income_observation.net_amount.amount

F0252 · decimal · Optional · Nullable: YesNet amount received for the stated period. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: 1234.56

income_observation.net_amount.currency

F0253 · string · Optional · Nullable: YesCurrency for net amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: CAD

income_observation.period_start

F0254 · date · Optional · Nullable: YesInclusive income period start.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: 2026-09-01

income_observation.period_end

F0255 · date · Optional · Nullable: YesInclusive income period end.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: 2026-09-30

income_observation.frequency

F0256 · enum:frequency · Optional · Nullable: YesIncome payment cadence.
  • Format / enum / units: Enum: frequency
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: monthly

income_observation.evidence_level

F0257 · enum:evidence_level · Required · Nullable: NoWhether the amount is reported, extracted or inferred.
  • Format / enum / units: Enum: evidence_level
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: source_record

income_observation.transaction_ids[]

F0258 · array<id> · Optional · Nullable: YesSupporting bank transactions.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: []

income_observation.document_ids[]

F0259 · array<id> · Optional · Nullable: YesSupporting income evidence.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: []

income_observation.verified_at

F0260 · datetime · Optional · Nullable: YesTime of verification, if a verification actually occurred.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Bank deposit classification alone is not payroll-verified gross income.
  • Source families: BANK entitled income products; client; AMLOK
  • Example: null

Payments

merchant_account.connection_id

F0261 · id · Required · Nullable: NoProvider connection for the merchant.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: cnn_merchant

merchant_account.merchant_id

F0262 · string · Optional · Nullable: YesProvider merchant identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: merchant_example

merchant_account.display_name

F0263 · string · Optional · Nullable: YesMerchant name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: Example Store

merchant_account.processor

F0264 · string · Optional · Nullable: YesPayment processor or acquirer name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: Example Processor

merchant_account.country

F0265 · string · Optional · Nullable: YesMerchant account jurisdiction.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: CA

merchant_account.settlement_currency

F0266 · string · Optional · Nullable: YesSettlement currency.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: CAD

merchant_account.status

F0267 · string · Optional · Nullable: YesProvider merchant account status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: active

merchant_account.settlement_schedule

F0268 · string · Optional · Nullable: YesReported settlement cadence.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: daily

merchant_account.payout_account_id

F0269 · id · Optional · Nullable: YesMatched bank destination account when established.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: bka_example

merchant_account.reserve_amount.amount

F0270 · decimal · Optional · Nullable: YesProvider-reported withheld reserve. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM marketplace settlement
  • Example: 1234.56

merchant_account.reserve_amount.currency

F0271 · string · Optional · Nullable: YesCurrency for reserve amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM marketplace settlement
  • Example: CAD

merchant_account.reserve_policy

F0272 · string · Optional · Nullable: YesReserve terms when explicitly provided.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM marketplace settlement
  • Example: rolling reserve

payment.merchant_account_id

F0273 · id · Optional · Nullable: YesMerchant processing account.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: mca_example

payment.order_id

F0274 · id · Optional · Nullable: YesRelated commerce order when matched.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: ord_example

payment.customer_id

F0275 · id · Optional · Nullable: YesRelated commercial counterparty.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: pty_example

payment.source_payment_id

F0276 · string · Optional · Nullable: YesUpstream payment identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: pay_provider

payment.status

F0277 · enum:payment_status · Required · Nullable: NoNormalized payment state.
  • Format / enum / units: Enum: payment_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: captured

payment.amount.amount

F0278 · decimal · Optional · Nullable: YesGross payment amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM; ACC
  • Example: 1234.56

payment.amount.currency

F0279 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM; ACC
  • Example: CAD

payment.captured_amount.amount

F0280 · decimal · Optional · Nullable: YesAmount captured by the merchant. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM; ACC
  • Example: 1234.56

payment.captured_amount.currency

F0281 · string · Optional · Nullable: YesCurrency for captured amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM; ACC
  • Example: CAD

payment.refunded_amount.amount

F0282 · decimal · Optional · Nullable: YesCumulative refund amount in the payment’s currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM; ACC
  • Example: 1234.56

payment.refunded_amount.currency

F0283 · string · Optional · Nullable: YesCurrency for refunded amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM; ACC
  • Example: CAD

payment.fee_amount.amount

F0284 · decimal · Optional · Nullable: YesProvider-reported fee attributable to this payment. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM; ACC
  • Example: 1234.56

payment.fee_amount.currency

F0285 · string · Optional · Nullable: YesCurrency for fee amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM; ACC
  • Example: CAD

payment.net_amount.amount

F0286 · decimal · Optional · Nullable: YesProvider-reported net settlement contribution. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM; ACC
  • Example: 1234.56

payment.net_amount.currency

F0287 · string · Optional · Nullable: YesCurrency for net amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM; ACC
  • Example: CAD

payment.method_type

F0288 · string · Optional · Nullable: YesPayment method category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: card

payment.card_brand

F0289 · string · Optional · Nullable: YesCard network if supplied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: visa

payment.card_last4

F0290 · string · Optional · Nullable: YesLast four digits only, when required for the workflow.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Never expose PAN, CVV or magnetic-stripe data.
  • Source families: PAY; ECOM; ACC
  • Example: 1234

payment.authorized_at

F0291 · datetime · Optional · Nullable: YesAuthorization timestamp.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: Not specified

payment.captured_at

F0292 · datetime · Optional · Nullable: YesCapture timestamp.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: Not specified

payment.settled_at

F0293 · datetime · Optional · Nullable: YesSettlement timestamp when established.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: Not specified

payment.failure_code

F0294 · string · Optional · Nullable: YesSanitized failure reason.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: null

payment.payout_id

F0295 · id · Optional · Nullable: YesPayout containing this payment if the source supplies a linkage.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM; ACC
  • Example: pyo_example

processor_transaction.merchant_account_id

F0296 · id · Required · Nullable: NoMerchant balance associated with this event.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: mca_example

processor_transaction.source_transaction_id

F0297 · string · Optional · Nullable: YesProvider ledger-event identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: txn_provider

processor_transaction.event_type

F0298 · string · Optional · Nullable: YesProvider ledger type, such as charge, refund or payout.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: charge

processor_transaction.gross.amount

F0299 · decimal · Optional · Nullable: YesSigned gross processor-balance movement. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Positive increases balance; retain source semantics in mapping.
  • Source families: PAY
  • Example: 1234.56

processor_transaction.gross.currency

F0300 · string · Optional · Nullable: YesCurrency for gross.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY
  • Example: CAD

processor_transaction.fee.amount

F0301 · decimal · Optional · Nullable: YesFee assessed by the processor for this event. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY
  • Example: 1234.56

processor_transaction.fee.currency

F0302 · string · Optional · Nullable: YesCurrency for fee.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY
  • Example: CAD

processor_transaction.net.amount

F0303 · decimal · Optional · Nullable: YesSigned net balance impact. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: For Stripe balance transactions, net equals amount minus fee.
  • Source families: PAY
  • Example: 1234.56

processor_transaction.net.currency

F0304 · string · Optional · Nullable: YesCurrency for net.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY
  • Example: CAD

processor_transaction.reporting_category

F0305 · string · Optional · Nullable: YesProvider accounting classification.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: charge

processor_transaction.availability_status

F0306 · string · Optional · Nullable: YesProvider fund availability state.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: available

processor_transaction.available_on

F0307 · date · Optional · Nullable: YesDate funds become available in the processor balance.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: 2026-10-22

processor_transaction.occurred_at

F0308 · datetime · Optional · Nullable: YesProvider ledger-event creation time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: Not specified

processor_transaction.source_object_id

F0309 · string · Optional · Nullable: YesUpstream object linked to this event.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: ch_example

processor_transaction.payment_id

F0310 · id · Optional · Nullable: YesNormalized payment link when resolved.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY
  • Example: pay_example

payout.merchant_account_id

F0311 · id · Required · Nullable: NoMerchant account initiating settlement.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: mca_example

payout.source_payout_id

F0312 · string · Optional · Nullable: YesProvider payout identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: po_example

payout.status

F0313 · enum:payout_status · Required · Nullable: NoNormalized settlement state.
  • Format / enum / units: Enum: payout_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: paid

payout.gross.amount

F0314 · decimal · Optional · Nullable: YesGross settled amount before deductions, if separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

payout.gross.currency

F0315 · string · Optional · Nullable: YesCurrency for gross.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

payout.fees.amount

F0316 · decimal · Optional · Nullable: YesSettlement deductions explicitly identified as fees. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

payout.fees.currency

F0317 · string · Optional · Nullable: YesCurrency for fees.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

payout.net.amount

F0318 · decimal · Optional · Nullable: YesAmount remitted to the destination. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

payout.net.currency

F0319 · string · Optional · Nullable: YesCurrency for net.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

payout.created_on

F0320 · date · Optional · Nullable: YesPayout initiation date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: 2026-10-21

payout.expected_arrival_on

F0321 · date · Optional · Nullable: YesExpected arrival, if provided.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: 2026-10-22

payout.paid_at

F0322 · datetime · Optional · Nullable: YesProvider-reported completion time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: Not specified

payout.destination_account_id

F0323 · id · Optional · Nullable: YesMatched destination bank account.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: bka_example

payout.bank_transaction_id

F0324 · id · Optional · Nullable: YesMatching deposit or debit record.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: btx_example

payout.reconciliation_status

F0325 · enum:reconciliation_status · Optional · Nullable: YesMatch state between settlement and bank movement.
  • Format / enum / units: Enum: reconciliation_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: matched

payout.failure_code

F0326 · string · Optional · Nullable: YesProvider failure reason if applicable.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: null

refund.payment_id

F0327 · id · Required · Nullable: NoOriginal payment being refunded.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: pay_example

refund.order_id

F0328 · id · Optional · Nullable: YesRelated order when known.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: ord_example

refund.amount.amount

F0329 · decimal · Optional · Nullable: YesRefund magnitude, nonnegative. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

refund.amount.currency

F0330 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

refund.status

F0331 · string · Optional · Nullable: YesProvider or mapped refund status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: succeeded

refund.reason

F0332 · string · Optional · Nullable: YesRefund reason supplied by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: requested_by_customer

refund.requested_at

F0333 · datetime · Optional · Nullable: YesRefund initiation time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: Not specified

refund.completed_at

F0334 · datetime · Optional · Nullable: YesCompletion time if confirmed.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: Not specified

refund.processor_transaction_id

F0335 · id · Optional · Nullable: YesLedger event representing the refund.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: ptx_example

dispute.payment_id

F0336 · id · Required · Nullable: NoDisputed payment.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: pay_example

dispute.amount.amount

F0337 · decimal · Optional · Nullable: YesDisputed amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

dispute.amount.currency

F0338 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

dispute.reason_code

F0339 · string · Optional · Nullable: YesProvider or network dispute category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: fraudulent

dispute.status

F0340 · enum:dispute_status · Required · Nullable: NoDispute process state.
  • Format / enum / units: Enum: dispute_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: under_review

dispute.opened_at

F0341 · datetime · Optional · Nullable: YesDispute opening time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: Not specified

dispute.response_due_at

F0342 · datetime · Optional · Nullable: YesProvider-specified evidence deadline.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: Not specified

dispute.closed_at

F0343 · datetime · Optional · Nullable: YesDispute closure time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: null

dispute.evidence_submitted

F0344 · boolean · Optional · Nullable: YesWhether a response was submitted.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: PAY; ECOM
  • Example: true

dispute.fee_amount.amount

F0345 · decimal · Optional · Nullable: YesDispute fee if separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: PAY; ECOM
  • Example: 1234.56

dispute.fee_amount.currency

F0346 · string · Optional · Nullable: YesCurrency for fee amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: PAY; ECOM
  • Example: CAD

Commerce

counterparty.counterparty_type

F0347 · string · Required · Nullable: NoCustomer, supplier or both.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: customer

counterparty.display_name

F0348 · string · Optional · Nullable: YesCommercial record’s display name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: Example Customer
F0349 · string · Optional · Nullable: YesLegal name when explicitly provided.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: Example Customer Ltd.

counterparty.resolved_entity_id

F0350 · id · Optional · Nullable: YesMatched AMLOK business or person.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: biz_customer

counterparty.email

F0351 · string · Optional · Nullable: YesAuthorized contact email.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: customer@example.com

counterparty.phone

F0352 · string · Optional · Nullable: YesAuthorized contact number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: +14165550102

counterparty.billing_address

F0353 · Address · Optional · Nullable: YesBilling address used by the source.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: {"city":"Ottawa","country":"CA"}

counterparty.shipping_address

F0354 · Address · Optional · Nullable: YesShipping address used by the source.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: null

counterparty.tax_identifier_token

F0355 · string · Optional · Nullable: YesVault reference for a tax identifier when permitted.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: null

counterparty.payment_terms_days

F0356 · integer · Optional · Nullable: YesContractual payment term where supplied.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: 30

counterparty.credit_limit.amount

F0357 · decimal · Optional · Nullable: YesSource-managed trade-credit limit. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY; ACC; INV
  • Example: 1234.56

counterparty.credit_limit.currency

F0358 · string · Optional · Nullable: YesCurrency for credit limit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY; ACC; INV
  • Example: CAD

counterparty.is_active

F0359 · boolean · Optional · Nullable: YesExplicit active status in the source system.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY; ACC; INV
  • Example: true

order.order_number

F0360 · string · Optional · Nullable: YesHuman-readable order reference.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: ORD-1001

order.source_order_id

F0361 · string · Optional · Nullable: YesProvider order identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: gid://example/Order/1001

order.customer_id

F0362 · id · Optional · Nullable: YesPurchasing counterparty.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: pty_example

order.location_id

F0363 · id · Optional · Nullable: YesStore or sales location.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: loc_example

order.channel

F0364 · string · Optional · Nullable: YesSales channel or marketplace.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: online

order.status

F0365 · enum:order_status · Required · Nullable: NoOrder lifecycle state.
  • Format / enum / units: Enum: order_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: completed

order.payment_status

F0366 · string · Optional · Nullable: YesCommercial order payment state from source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: paid

order.fulfillment_status

F0367 · enum:fulfillment_status · Optional · Nullable: YesOrder fulfillment progress.
  • Format / enum / units: Enum: fulfillment_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: fulfilled

order.placed_at

F0368 · datetime · Optional · Nullable: YesOrder creation or placement time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: Not specified

order.cancelled_at

F0369 · datetime · Optional · Nullable: YesCancellation time when cancelled.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: null

order.subtotal.amount

F0370 · decimal · Optional · Nullable: YesLine subtotal before tax under the specified source convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.subtotal.currency

F0371 · string · Optional · Nullable: YesCurrency for subtotal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.discount_total.amount

F0372 · decimal · Optional · Nullable: YesDiscounts applied to the order. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.discount_total.currency

F0373 · string · Optional · Nullable: YesCurrency for discount total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.tax_total.amount

F0374 · decimal · Optional · Nullable: YesTax attributed to the order. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.tax_total.currency

F0375 · string · Optional · Nullable: YesCurrency for tax total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.shipping_total.amount

F0376 · decimal · Optional · Nullable: YesShipping charged on the order. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.shipping_total.currency

F0377 · string · Optional · Nullable: YesCurrency for shipping total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.total.amount

F0378 · decimal · Optional · Nullable: YesOriginal total including taxes and discounts, before subsequent returns. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.total.currency

F0379 · string · Optional · Nullable: YesCurrency for total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.current_total.amount

F0380 · decimal · Optional · Nullable: YesCurrent adjusted order total after changes under source semantics. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.current_total.currency

F0381 · string · Optional · Nullable: YesCurrency for current total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.refunded_total.amount

F0382 · decimal · Optional · Nullable: YesCumulative refunded order amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order.refunded_total.currency

F0383 · string · Optional · Nullable: YesCurrency for refunded total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order.presentment_currency

F0384 · string · Optional · Nullable: YesCurrency shown to the buyer.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: USD

order.taxes_included

F0385 · boolean · Optional · Nullable: YesWhether listed prices already include tax.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: false

order.is_test

F0386 · boolean · Optional · Nullable: YesExplicit test-order indicator.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: false

order.line_ids[]

F0387 · array<id> · Optional · Nullable: YesNormalized order lines.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: ["oli_example"]

order_line.order_id

F0388 · id · Required · Nullable: NoParent order.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: ord_example

order_line.product_id

F0389 · id · Optional · Nullable: YesNormalized product reference.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: prd_example

order_line.sku

F0390 · string · Optional · Nullable: YesSource stock-keeping unit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: SKU-1001

order_line.description

F0391 · string · Optional · Nullable: YesLine item label.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: Steel component

order_line.quantity

F0392 · decimal · Optional · Nullable: YesQuantity ordered.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Units must be interpreted with unit_of_measure.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 10

order_line.unit_of_measure

F0393 · string · Optional · Nullable: YesUnit used for quantity.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: each

order_line.unit_price.amount

F0394 · decimal · Optional · Nullable: YesPrice per unit under source tax convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order_line.unit_price.currency

F0395 · string · Optional · Nullable: YesCurrency for unit price.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order_line.discount_amount.amount

F0396 · decimal · Optional · Nullable: YesLine discount amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order_line.discount_amount.currency

F0397 · string · Optional · Nullable: YesCurrency for discount amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order_line.tax_amount.amount

F0398 · decimal · Optional · Nullable: YesLine tax amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order_line.tax_amount.currency

F0399 · string · Optional · Nullable: YesCurrency for tax amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order_line.line_total.amount

F0400 · decimal · Optional · Nullable: YesExtended line total with stated tax convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 1234.56

order_line.line_total.currency

F0401 · string · Optional · Nullable: YesCurrency for line total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: CAD

order_line.quantity_fulfilled

F0402 · decimal · Optional · Nullable: YesQuantity fulfilled.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 10

order_line.quantity_refunded

F0403 · decimal · Optional · Nullable: YesQuantity returned or refunded when supplied.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM; PAY POS; INV OMS
  • Example: 0

subscription.customer_id

F0404 · id · Required · Nullable: NoSubscriber counterparty.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: pty_example

subscription.product_id

F0405 · id · Optional · Nullable: YesRecurring product or plan.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: prd_example

subscription.status

F0406 · string · Optional · Nullable: YesProvider subscription status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: active

subscription.frequency

F0407 · enum:frequency · Optional · Nullable: YesContractual billing cadence.
  • Format / enum / units: Enum: frequency
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: monthly

subscription.recurring_amount.amount

F0408 · decimal · Optional · Nullable: YesCurrent recurring charge for one billing cycle. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: 1234.56

subscription.recurring_amount.currency

F0409 · string · Optional · Nullable: YesCurrency for recurring amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: CAD

subscription.started_on

F0410 · date · Optional · Nullable: YesContract start date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: 2026-01-01

subscription.current_period_start

F0411 · date · Optional · Nullable: YesStart of current billing period.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: 2026-10-01

subscription.current_period_end

F0412 · date · Optional · Nullable: YesEnd of current billing period, exclusive.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: 2026-11-01

subscription.cancelled_on

F0413 · date · Optional · Nullable: YesCancellation date when supplied.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: null

subscription.next_billing_on

F0414 · date · Optional · Nullable: YesNext scheduled charge date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Only if the connected provider and licensed module expose subscriptions; an order feed alone is insufficient.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ECOM subscription modules; PAY billing products
  • Example: 2026-11-01

Accounting

ledger_account.code

F0415 · string · Optional · Nullable: YesSource account code.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: 4000

ledger_account.name

F0416 · string · Optional · Nullable: YesAccount label.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: Product sales

ledger_account.account_type

F0417 · enum:gl_type · Required · Nullable: NoAMLOK accounting classification.
  • Format / enum / units: Enum: gl_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: revenue

ledger_account.source_account_type

F0418 · string · Optional · Nullable: YesUnmodified source account classification.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: Income

ledger_account.parent_account_id

F0419 · id · Optional · Nullable: YesParent in the chart of accounts.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: gla_parent

ledger_account.normal_balance

F0420 · enum:debit_credit · Optional · Nullable: YesNormal ledger balance direction.
  • Format / enum / units: Enum: debit_credit
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: credit

ledger_account.currency

F0421 · string · Optional · Nullable: YesAccount-specific currency if applicable.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: CAD

ledger_account.is_active

F0422 · boolean · Optional · Nullable: YesExplicit chart-of-accounts active state.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: true

ledger_account.is_trust_account

F0423 · boolean · Optional · Nullable: YesWhether account holds third-party trust money.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not include client trust balances in available operating liquidity.
  • Source families: ACC; INV financial modules
  • Example: false

journal.journal_number

F0424 · string · Optional · Nullable: YesSource journal reference.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: JE-1001

journal.posted_on

F0425 · date · Optional · Nullable: YesAccounting posting date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: 2026-09-30

journal.description

F0426 · string · Optional · Nullable: YesJournal narrative.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: Month-end accrual

journal.status

F0427 · string · Optional · Nullable: YesSource posting state.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: posted

journal.source_document_type

F0428 · string · Optional · Nullable: YesOriginating record type.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: invoice

journal.source_document_id

F0429 · id · Optional · Nullable: YesNormalized originating transaction.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: inv_example

journal.reverses_journal_id

F0430 · id · Optional · Nullable: YesJournal being reversed if supplied.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: null

journal.line_ids[]

F0431 · array<id> · Optional · Nullable: YesJournal lines belonging to this posting.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: ["jli_debit","jli_credit"]

journal_line.journal_id

F0432 · id · Required · Nullable: NoParent posting.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: jnl_example

journal_line.ledger_account_id

F0433 · id · Required · Nullable: NoAffected ledger account.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: gla_example

journal_line.debit.amount

F0434 · decimal · Optional · Nullable: YesDebit amount; nonnegative. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules
  • Example: 1234.56

journal_line.debit.currency

F0435 · string · Optional · Nullable: YesCurrency for debit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules
  • Example: CAD

journal_line.credit.amount

F0436 · decimal · Optional · Nullable: YesCredit amount; nonnegative. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules
  • Example: 1234.56

journal_line.credit.currency

F0437 · string · Optional · Nullable: YesCurrency for credit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules
  • Example: CAD

journal_line.base_debit.amount

F0438 · decimal · Optional · Nullable: YesDebit in the company’s reporting currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules
  • Example: 1234.56

journal_line.base_debit.currency

F0439 · string · Optional · Nullable: YesCurrency for base debit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules
  • Example: CAD

journal_line.base_credit.amount

F0440 · decimal · Optional · Nullable: YesCredit in the company’s reporting currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules
  • Example: 1234.56

journal_line.base_credit.currency

F0441 · string · Optional · Nullable: YesCurrency for base credit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules
  • Example: CAD

journal_line.description

F0442 · string · Optional · Nullable: YesLine narrative.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: Invoice posting

journal_line.department

F0443 · string · Optional · Nullable: YesSource department or dimension.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: Manufacturing

journal_line.project_id

F0444 · id · Optional · Nullable: YesProject/job reference.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: prj_example

journal_line.counterparty_id

F0445 · id · Optional · Nullable: YesCommercial party if linked.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules
  • Example: pty_example

invoice.number

F0446 · string · Optional · Nullable: YesPrintable document number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: INV-1001

invoice.counterparty_id

F0447 · id · Required · Nullable: NoCustomer for invoices or supplier for bills.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: pty_example

invoice.issued_on

F0448 · date · Optional · Nullable: YesDocument issue date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 2026-09-01

invoice.due_on

F0449 · date · Optional · Nullable: YesContractual payment due date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 2026-10-01

invoice.status

F0450 · enum:invoice_status · Required · Nullable: NoNormalized receivable/payable state.
  • Format / enum / units: Enum: invoice_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Do not infer void status solely from a zero balance.
  • Source families: ACC; INV; ECOM invoicing
  • Example: partially_paid

invoice.subtotal.amount

F0451 · decimal · Optional · Nullable: YesAmount before tax under the source convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.subtotal.currency

F0452 · string · Optional · Nullable: YesCurrency for subtotal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.tax_total.amount

F0453 · decimal · Optional · Nullable: YesTotal tax charged. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.tax_total.currency

F0454 · string · Optional · Nullable: YesCurrency for tax total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.total.amount

F0455 · decimal · Optional · Nullable: YesDocument total including tax. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.total.currency

F0456 · string · Optional · Nullable: YesCurrency for total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.amount_due.amount

F0457 · decimal · Optional · Nullable: YesOutstanding document amount after source-applied allocations. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.amount_due.currency

F0458 · string · Optional · Nullable: YesCurrency for amount due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.amount_paid.amount

F0459 · decimal · Optional · Nullable: YesPayments applied, where separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.amount_paid.currency

F0460 · string · Optional · Nullable: YesCurrency for amount paid.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.amount_credited.amount

F0461 · decimal · Optional · Nullable: YesCredits or prepayments applied, separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.amount_credited.currency

F0462 · string · Optional · Nullable: YesCurrency for amount credited.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.fully_paid_on

F0463 · date · Optional · Nullable: YesDate full payment was completed.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: null

invoice.payment_terms_days

F0464 · integer · Optional · Nullable: YesContractual term when explicitly reported.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 30

invoice.line_items[]

F0465 · array<InvoiceLine> · Optional · Nullable: YesItemized quantities, prices, account codes and tax amounts.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: []

invoice.document_id

F0466 · id · Optional · Nullable: YesEvidence document for the record.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM invoicing
  • Example: doc_invoice

invoice.home_total.amount

F0467 · decimal · Optional · Nullable: YesTotal translated to the ledger’s home currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1234.56

invoice.home_total.currency

F0468 · string · Optional · Nullable: YesCurrency for home total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM invoicing
  • Example: CAD

invoice.exchange_rate

F0469 · decimal · Optional · Nullable: YesHome-currency units per document-currency unit.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Use source rate and effective date; do not silently reverse the quote.
  • Source families: ACC; INV; ECOM invoicing
  • Example: 1.35

bill.number

F0470 · string · Optional · Nullable: YesPrintable document number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: INV-1001

bill.counterparty_id

F0471 · id · Required · Nullable: NoCustomer for invoices or supplier for bills.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: pty_example

bill.issued_on

F0472 · date · Optional · Nullable: YesDocument issue date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: 2026-09-01

bill.due_on

F0473 · date · Optional · Nullable: YesContractual payment due date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: 2026-10-01

bill.status

F0474 · enum:invoice_status · Required · Nullable: NoNormalized receivable/payable state.
  • Format / enum / units: Enum: invoice_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Do not infer void status solely from a zero balance.
  • Source families: ACC; INV
  • Example: partially_paid

bill.subtotal.amount

F0475 · decimal · Optional · Nullable: YesAmount before tax under the source convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.subtotal.currency

F0476 · string · Optional · Nullable: YesCurrency for subtotal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.tax_total.amount

F0477 · decimal · Optional · Nullable: YesTotal tax charged. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.tax_total.currency

F0478 · string · Optional · Nullable: YesCurrency for tax total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.total.amount

F0479 · decimal · Optional · Nullable: YesDocument total including tax. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.total.currency

F0480 · string · Optional · Nullable: YesCurrency for total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.amount_due.amount

F0481 · decimal · Optional · Nullable: YesOutstanding document amount after source-applied allocations. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.amount_due.currency

F0482 · string · Optional · Nullable: YesCurrency for amount due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.amount_paid.amount

F0483 · decimal · Optional · Nullable: YesPayments applied, where separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.amount_paid.currency

F0484 · string · Optional · Nullable: YesCurrency for amount paid.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.amount_credited.amount

F0485 · decimal · Optional · Nullable: YesCredits or prepayments applied, separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.amount_credited.currency

F0486 · string · Optional · Nullable: YesCurrency for amount credited.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.fully_paid_on

F0487 · date · Optional · Nullable: YesDate full payment was completed.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: null

bill.payment_terms_days

F0488 · integer · Optional · Nullable: YesContractual term when explicitly reported.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: 30

bill.line_items[]

F0489 · array<InvoiceLine> · Optional · Nullable: YesItemized quantities, prices, account codes and tax amounts.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: []

bill.document_id

F0490 · id · Optional · Nullable: YesEvidence document for the record.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: doc_invoice

bill.home_total.amount

F0491 · decimal · Optional · Nullable: YesTotal translated to the ledger’s home currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

bill.home_total.currency

F0492 · string · Optional · Nullable: YesCurrency for home total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

bill.exchange_rate

F0493 · decimal · Optional · Nullable: YesHome-currency units per document-currency unit.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Use source rate and effective date; do not silently reverse the quote.
  • Source families: ACC; INV
  • Example: 1.35

credit_note.number

F0494 · string · Optional · Nullable: YesCredit note reference.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: CN-1001

credit_note.counterparty_id

F0495 · id · Required · Nullable: NoCustomer or supplier.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: pty_example

credit_note.invoice_id

F0496 · id · Optional · Nullable: YesRelated receivable if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: inv_example

credit_note.bill_id

F0497 · id · Optional · Nullable: YesRelated payable if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: null

credit_note.issued_on

F0498 · date · Optional · Nullable: YesCredit note date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: 2026-10-01

credit_note.status

F0499 · string · Optional · Nullable: YesSource credit note state.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: authorized

credit_note.total.amount

F0500 · decimal · Optional · Nullable: YesAbsolute credit note amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM
  • Example: 1234.56

credit_note.total.currency

F0501 · string · Optional · Nullable: YesCurrency for total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM
  • Example: CAD

credit_note.remaining_credit.amount

F0502 · decimal · Optional · Nullable: YesCredit still available for allocation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV; ECOM
  • Example: 1234.56

credit_note.remaining_credit.currency

F0503 · string · Optional · Nullable: YesCurrency for remaining credit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV; ECOM
  • Example: CAD

credit_note.reason

F0504 · string · Optional · Nullable: YesSource adjustment explanation.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV; ECOM
  • Example: Returned goods

accounting_payment.counterparty_id

F0505 · id · Optional · Nullable: YesCustomer or supplier.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: pty_example

accounting_payment.direction

F0506 · enum:direction · Required · Nullable: NoReceipt or disbursement from the business perspective.
  • Format / enum / units: Enum: direction
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: inflow

accounting_payment.amount.amount

F0507 · decimal · Optional · Nullable: YesTotal allocated cash payment. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV
  • Example: 1234.56

accounting_payment.amount.currency

F0508 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV
  • Example: CAD

accounting_payment.paid_on

F0509 · date · Optional · Nullable: YesAccounting payment date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: 2026-10-01

accounting_payment.bank_account_id

F0510 · id · Optional · Nullable: YesMatched financial account when known.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: bka_example

accounting_payment.ledger_account_id

F0511 · id · Optional · Nullable: YesLedger cash or clearing account.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: gla_cash

accounting_payment.allocations[]

F0512 · array<Allocation> · Optional · Nullable: YesAmounts allocated to invoices, bills or credits.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: []

accounting_payment.bank_transaction_id

F0513 · id · Optional · Nullable: YesMatched financial-account movement.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: btx_example

accounting_payment.reconciliation_status

F0514 · enum:reconciliation_status · Optional · Nullable: YesState of matching ledger payment to bank movement.
  • Format / enum / units: Enum: reconciliation_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV
  • Example: matched

financial_statement.statement_type

F0515 · enum:statement_type · Required · Nullable: NoFinancial report kind.
  • Format / enum / units: Enum: statement_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: income_statement

financial_statement.period_start

F0516 · date · Optional · Nullable: YesStart of reporting period for flow statements.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-01-01

financial_statement.period_end

F0517 · date · Required · Nullable: NoInclusive reporting end or balance-sheet date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-09-30

financial_statement.accounting_basis

F0518 · enum:accounting_basis · Required · Nullable: NoCash or accrual basis.
  • Format / enum / units: Enum: accounting_basis
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: accrual

financial_statement.currency

F0519 · string · Required · Nullable: NoPresentation currency of the report.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: CAD

financial_statement.is_consolidated

F0520 · boolean · Optional · Nullable: YesWhether multiple legal entities are consolidated.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: false

financial_statement.is_audited

F0521 · boolean · Optional · Nullable: YesWhether an audit opinion is actually evidenced.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Software-generated reports are not automatically audited.
  • Source families: ACC; INV financial modules; client documents
  • Example: false

financial_statement.source_report_name

F0522 · string · Optional · Nullable: YesName of the upstream report.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: Profit and Loss

financial_statement.generated_at

F0523 · datetime · Optional · Nullable: YesSource report generation time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: Not specified

financial_statement.document_id

F0524 · id · Optional · Nullable: YesEvidence copy of the statement.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: doc_statement

financial_statement.line_ids[]

F0525 · array<id> · Optional · Nullable: YesStandardized report lines.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: ["fsl_revenue","fsl_expense"]

statement_line.statement_id

F0526 · id · Required · Nullable: NoParent financial statement.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: fst_example

statement_line.line_code

F0527 · string · Required · Nullable: NoAMLOK normalized statement concept.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Mapping depends on account chart and reporting basis.
  • Source families: ACC; INV financial modules; document extraction
  • Example: revenue

statement_line.source_label

F0528 · string · Optional · Nullable: YesOriginal report line label.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: Total Income

statement_line.parent_line_id

F0529 · id · Optional · Nullable: YesParent subtotal or grouping line.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: null

statement_line.amount.amount

F0530 · decimal · Optional · Nullable: YesReported line amount in statement currency. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules; document extraction
  • Example: 1234.56

statement_line.amount.currency

F0531 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules; document extraction
  • Example: CAD

statement_line.is_total

F0532 · boolean · Optional · Nullable: YesWhether this line is a subtotal or total.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: true

statement_line.ledger_account_ids[]

F0533 · array<id> · Optional · Nullable: YesAccounts contributing to the line when exposed.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: []

statement_line.mapping_method

F0534 · string · Optional · Nullable: YesHow source lines were assigned to the normalized concept.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; document extraction
  • Example: reviewed_account_mapping

tax_obligation.tax_type

F0535 · string · Optional · Nullable: YesJurisdiction-specific tax category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: GST_HST

tax_obligation.jurisdiction

F0536 · string · Optional · Nullable: YesRelevant taxing jurisdiction.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: CA

tax_obligation.period_start

F0537 · date · Optional · Nullable: YesTax reporting period start.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-07-01

tax_obligation.period_end

F0538 · date · Optional · Nullable: YesTax reporting period end.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-09-30

tax_obligation.due_on

F0539 · date · Optional · Nullable: YesPayment or filing deadline when supplied.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-10-31

tax_obligation.amount_due.amount

F0540 · decimal · Optional · Nullable: YesReported tax payable. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules; client documents
  • Example: 1234.56

tax_obligation.amount_due.currency

F0541 · string · Optional · Nullable: YesCurrency for amount due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules; client documents
  • Example: CAD

tax_obligation.amount_paid.amount

F0542 · decimal · Optional · Nullable: YesRecorded payment against the obligation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC; INV financial modules; client documents
  • Example: 1234.56

tax_obligation.amount_paid.currency

F0543 · string · Optional · Nullable: YesCurrency for amount paid.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC; INV financial modules; client documents
  • Example: CAD

tax_obligation.filing_status

F0544 · string · Optional · Nullable: YesSource-reported filing status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: filed

tax_obligation.filed_on

F0545 · date · Optional · Nullable: YesActual filing date when evidenced.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: 2026-10-20

tax_obligation.document_id

F0546 · id · Optional · Nullable: YesSupporting return or receipt.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Accounting or supplied-return evidence only; no direct CRA/IRS account integration is established by the inventory.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC; INV financial modules; client documents
  • Example: doc_tax

Inventory

product.sku

F0547 · string · Optional · Nullable: YesStock-keeping identifier within the source tenant.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: SKU-1001

product.name

F0548 · string · Optional · Nullable: YesProduct or service name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: Steel component

product.description

F0549 · string · Optional · Nullable: YesSource item description.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: Machined steel component

product.product_type

F0550 · string · Optional · Nullable: YesGoods, service, bundle or source-specific category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: goods

product.category

F0551 · string · Optional · Nullable: YesProduct category supplied by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: Components

product.unit_of_measure

F0552 · string · Optional · Nullable: YesBase stock unit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: each

product.is_active

F0553 · boolean · Optional · Nullable: YesSource active status.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: true

product.is_inventory_tracked

F0554 · boolean · Optional · Nullable: YesWhether source maintains stock quantities.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: true

product.unit_cost.amount

F0555 · decimal · Optional · Nullable: YesSource carrying cost per unit; not market value. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: 1234.56

product.unit_cost.currency

F0556 · string · Optional · Nullable: YesCurrency for unit cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: CAD

product.sale_price.amount

F0557 · decimal · Optional · Nullable: YesCurrent catalog selling price; not realized revenue. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: 1234.56

product.sale_price.currency

F0558 · string · Optional · Nullable: YesCurrency for sale price.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: CAD

product.costing_method

F0559 · string · Optional · Nullable: YesSource valuation policy.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: fifo

product.barcode

F0560 · string · Optional · Nullable: YesBarcode or GTIN when supplied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: 0000000000000

product.supplier_id

F0561 · id · Optional · Nullable: YesPreferred supplier counterparty.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS; ACC items
  • Example: pty_supplier

location.name

F0562 · string · Optional · Nullable: YesLocation display name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: Toronto warehouse

location.location_type

F0563 · string · Optional · Nullable: YesWarehouse, store, branch or source-specific type.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: warehouse

location.address

F0564 · Address · Optional · Nullable: YesPhysical location address.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: {"city":"Toronto","country":"CA"}

location.is_active

F0565 · boolean · Optional · Nullable: YesLocation active state.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: true

location.owner_entity_id

F0566 · id · Optional · Nullable: YesOwner or operator if established.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: biz_example

location.timezone

F0567 · string · Optional · Nullable: YesIANA timezone used for operational dates.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM; PAY POS
  • Example: America/Toronto

inventory_balance.product_id

F0568 · id · Required · Nullable: NoItem represented by the stock balance.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: prd_example

inventory_balance.location_id

F0569 · id · Optional · Nullable: YesWarehouse or store holding the stock.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: loc_example

inventory_balance.owner_entity_id

F0570 · id · Optional · Nullable: YesEntity owning the stock, distinct from its custodian.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: biz_example

inventory_balance.ownership_type

F0571 · enum:stock_ownership · Required · Nullable: NoOwned, consigned or third-party stock.
  • Format / enum / units: Enum: stock_ownership
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: owned

inventory_balance.quantity_on_hand

F0572 · decimal · Optional · Nullable: YesPhysical stock recorded at the observation time.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 125

inventory_balance.quantity_available

F0573 · decimal · Optional · Nullable: YesSource-defined unreserved quantity available to sell.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 100

inventory_balance.quantity_reserved

F0574 · decimal · Optional · Nullable: YesQuantity committed or allocated.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 25

inventory_balance.quantity_on_order

F0575 · decimal · Optional · Nullable: YesQuantity expected from purchase orders.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 50

inventory_balance.unit_of_measure

F0576 · string · Optional · Nullable: YesUnit for all quantities on this record.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: each

inventory_balance.carrying_value.amount

F0577 · decimal · Optional · Nullable: YesBook valuation of the represented stock. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 1234.56

inventory_balance.carrying_value.currency

F0578 · string · Optional · Nullable: YesCurrency for carrying value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: CAD

inventory_balance.unit_cost.amount

F0579 · decimal · Optional · Nullable: YesUnit valuation used for this snapshot. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: 1234.56

inventory_balance.unit_cost.currency

F0580 · string · Optional · Nullable: YesCurrency for unit cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: CAD

inventory_balance.costing_method

F0581 · string · Optional · Nullable: YesSource costing policy.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: fifo

inventory_balance.lot_number

F0582 · string · Optional · Nullable: YesBatch or lot identifier when tracked.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: LOT-1001

inventory_balance.serial_number

F0583 · string · Optional · Nullable: YesUnit serial number when tracked.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: null

inventory_balance.expiry_on

F0584 · date · Optional · Nullable: YesProduct or lot expiry date when tracked.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: null

inventory_balance.as_of

F0585 · datetime · Optional · Nullable: YesTime represented by the stock observation.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Quantity, cost, history and stock ownership depend on product, module and tenant. A WMS balance need not be borrower-owned collateral.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules; PAY POS
  • Example: Not specified

inventory_movement.product_id

F0586 · id · Required · Nullable: NoAffected item.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: prd_example

inventory_movement.location_id

F0587 · id · Optional · Nullable: YesLocation affected by this movement.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: loc_example

inventory_movement.movement_type

F0588 · enum:movement_type · Required · Nullable: NoReason for stock movement.
  • Format / enum / units: Enum: movement_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: receipt

inventory_movement.quantity_delta

F0589 · decimal · Optional · Nullable: YesSigned change in stock at this location.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Positive adds stock; negative removes stock.
  • Source families: INV; ECOM inventory modules
  • Example: 50

inventory_movement.unit_of_measure

F0590 · string · Optional · Nullable: YesUnit for quantity_delta.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: each

inventory_movement.occurred_at

F0591 · datetime · Optional · Nullable: YesOperational event time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: Not specified

inventory_movement.unit_cost.amount

F0592 · decimal · Optional · Nullable: YesCost per unit recorded for the movement. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM inventory modules
  • Example: 1234.56

inventory_movement.unit_cost.currency

F0593 · string · Optional · Nullable: YesCurrency for unit cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM inventory modules
  • Example: CAD

inventory_movement.total_cost.amount

F0594 · decimal · Optional · Nullable: YesSigned carrying-value change associated with movement. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ECOM inventory modules
  • Example: 1234.56

inventory_movement.total_cost.currency

F0595 · string · Optional · Nullable: YesCurrency for total cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ECOM inventory modules
  • Example: CAD

inventory_movement.order_id

F0596 · id · Optional · Nullable: YesRelated sales order if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: null

inventory_movement.purchase_order_id

F0597 · id · Optional · Nullable: YesRelated purchase order if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: por_example

inventory_movement.transfer_pair_id

F0598 · string · Optional · Nullable: YesCorrelation between paired inter-location movements.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: transfer_example

inventory_movement.source_document_id

F0599 · id · Optional · Nullable: YesSupporting receipt or adjustment evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ECOM inventory modules
  • Example: doc_receipt

purchase_order.number

F0600 · string · Optional · Nullable: YesPurchase order number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: PO-1001

purchase_order.supplier_id

F0601 · id · Required · Nullable: NoSupplier commercial counterparty.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: pty_supplier

purchase_order.status

F0602 · enum:purchase_status · Required · Nullable: NoPurchase order state.
  • Format / enum / units: Enum: purchase_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: issued

purchase_order.ordered_on

F0603 · date · Optional · Nullable: YesPurchase order date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: 2026-10-01

purchase_order.expected_delivery_on

F0604 · date · Optional · Nullable: YesExpected receipt date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: 2026-11-01

purchase_order.total.amount

F0605 · decimal · Optional · Nullable: YesOrdered value under source tax convention. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ACC purchasing modules
  • Example: 1234.56

purchase_order.total.currency

F0606 · string · Optional · Nullable: YesCurrency for total.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ACC purchasing modules
  • Example: CAD

purchase_order.amount_received.amount

F0607 · decimal · Optional · Nullable: YesValue of goods or services received if reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV; ACC purchasing modules
  • Example: 1234.56

purchase_order.amount_received.currency

F0608 · string · Optional · Nullable: YesCurrency for amount received.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV; ACC purchasing modules
  • Example: CAD

purchase_order.line_items[]

F0609 · array<PurchaseLine> · Optional · Nullable: YesOrdered and received quantities, prices and item references.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: []

purchase_order.location_id

F0610 · id · Optional · Nullable: YesReceiving location.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV; ACC purchasing modules
  • Example: loc_example

shipment.direction

F0611 · string · Required · Nullable: NoInbound receipt or outbound dispatch.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: outbound

shipment.order_id

F0612 · id · Optional · Nullable: YesRelated sales order.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: ord_example

shipment.purchase_order_id

F0613 · id · Optional · Nullable: YesRelated purchase order for inbound receipts.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: null

shipment.location_id

F0614 · id · Optional · Nullable: YesOrigin or receiving warehouse.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: loc_example

shipment.status

F0615 · string · Optional · Nullable: YesSource shipment state.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: delivered

shipment.carrier

F0616 · string · Optional · Nullable: YesLogistics carrier when supplied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: Example Carrier

shipment.tracking_number

F0617 · string · Optional · Nullable: YesSource tracking reference.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: TRACK-EXAMPLE

shipment.shipped_at

F0618 · datetime · Optional · Nullable: YesDispatch time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: Not specified

shipment.delivered_at

F0619 · datetime · Optional · Nullable: YesConfirmed delivery time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: Not specified

shipment.line_items[]

F0620 · array<ShipmentLine> · Optional · Nullable: YesProduct quantities shipped or received.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV WMS/OMS; ECOM fulfillment
  • Example: []

production_order.number

F0621 · string · Optional · Nullable: YesProduction or work order identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: WO-1001

production_order.product_id

F0622 · id · Optional · Nullable: YesFinished item to produce.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: prd_example

production_order.status

F0623 · enum:manufacturing_status · Optional · Nullable: YesManufacturing work order state.
  • Format / enum / units: Enum: manufacturing_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: in_progress

production_order.quantity_planned

F0624 · decimal · Optional · Nullable: YesTarget output quantity.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: 100

production_order.quantity_completed

F0625 · decimal · Optional · Nullable: YesRecorded good output quantity.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: 70

production_order.quantity_scrapped

F0626 · decimal · Optional · Nullable: YesRecorded scrapped output quantity.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: 5

production_order.unit_of_measure

F0627 · string · Optional · Nullable: YesUnit for output quantities.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: each

production_order.planned_start_on

F0628 · date · Optional · Nullable: YesScheduled work start.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: 2026-10-01

production_order.planned_end_on

F0629 · date · Optional · Nullable: YesScheduled completion.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: 2026-10-30

production_order.completed_on

F0630 · date · Optional · Nullable: YesActual completion date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: INV manufacturing ERP/MES
  • Example: null

production_order.material_cost.amount

F0631 · decimal · Optional · Nullable: YesMaterial cost incurred under source accounting. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV manufacturing ERP/MES
  • Example: 1234.56

production_order.material_cost.currency

F0632 · string · Optional · Nullable: YesCurrency for material cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV manufacturing ERP/MES
  • Example: CAD

production_order.labor_cost.amount

F0633 · decimal · Optional · Nullable: YesLabor cost charged to the work order. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV manufacturing ERP/MES
  • Example: 1234.56

production_order.labor_cost.currency

F0634 · string · Optional · Nullable: YesCurrency for labor cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV manufacturing ERP/MES
  • Example: CAD

production_order.overhead_cost.amount

F0635 · decimal · Optional · Nullable: YesOverhead assigned by the source. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV manufacturing ERP/MES
  • Example: 1234.56

production_order.overhead_cost.currency

F0636 · string · Optional · Nullable: YesCurrency for overhead cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV manufacturing ERP/MES
  • Example: CAD

production_order.work_in_progress_value.amount

F0637 · decimal · Optional · Nullable: YesSource carrying value of incomplete production. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: INV manufacturing ERP/MES
  • Example: 1234.56

production_order.work_in_progress_value.currency

F0638 · string · Optional · Nullable: YesCurrency for work in progress value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: INV manufacturing ERP/MES
  • Example: CAD

project.number

F0639 · string · Optional · Nullable: YesSource project or job identifier.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: JOB-1001

project.name

F0640 · string · Optional · Nullable: YesProject name.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: Warehouse fit-out

project.customer_id

F0641 · id · Optional · Nullable: YesCustomer commissioning the project.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: pty_example

project.status

F0642 · enum:project_status · Optional · Nullable: YesProject execution state.
  • Format / enum / units: Enum: project_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: active

project.started_on

F0643 · date · Optional · Nullable: YesActual or reported start date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: 2026-07-01

project.expected_end_on

F0644 · date · Optional · Nullable: YesCurrent expected completion date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: ACC project/construction; INV project ERP
  • Example: 2027-01-31

project.contract_value.amount

F0645 · decimal · Optional · Nullable: YesCurrent contract amount, where supplied. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC project/construction; INV project ERP
  • Example: 1234.56

project.contract_value.currency

F0646 · string · Optional · Nullable: YesCurrency for contract value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC project/construction; INV project ERP
  • Example: CAD

project.budget_cost.amount

F0647 · decimal · Optional · Nullable: YesApproved cost budget. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC project/construction; INV project ERP
  • Example: 1234.56

project.budget_cost.currency

F0648 · string · Optional · Nullable: YesCurrency for budget cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC project/construction; INV project ERP
  • Example: CAD

project.actual_cost.amount

F0649 · decimal · Optional · Nullable: YesCost posted to the project to date. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC project/construction; INV project ERP
  • Example: 1234.56

project.actual_cost.currency

F0650 · string · Optional · Nullable: YesCurrency for actual cost.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC project/construction; INV project ERP
  • Example: CAD

project.amount_billed.amount

F0651 · decimal · Optional · Nullable: YesCumulative invoicing assigned to the project. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC project/construction; INV project ERP
  • Example: 1234.56

project.amount_billed.currency

F0652 · string · Optional · Nullable: YesCurrency for amount billed.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC project/construction; INV project ERP
  • Example: CAD

project.retainage_receivable.amount

F0653 · decimal · Optional · Nullable: YesContractually withheld receivable if exposed. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: ACC project/construction; INV project ERP
  • Example: 1234.56

project.retainage_receivable.currency

F0654 · string · Optional · Nullable: YesCurrency for retainage receivable.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: ACC project/construction; INV project ERP
  • Example: CAD

project.percent_complete

F0655 · decimal · Optional · Nullable: YesSource-reported completion fraction.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: 0 to 1; retain method; billed fraction is not physical completion.
  • Source families: ACC project/construction; INV project ERP
  • Example: 0.45

Lending

application.applicant_entity_id

F0656 · id · Required · Nullable: NoBusiness or person applying for credit.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: biz_example

application.product_type

F0657 · enum:credit_product · Required · Nullable: NoRequested financial product.
  • Format / enum / units: Enum: credit_product
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: term_loan

application.status

F0658 · enum:application_status · Required · Nullable: NoApplication state.
  • Format / enum / units: Enum: application_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: in_review

application.requested_amount.amount

F0659 · decimal · Optional · Nullable: YesRequested principal or limit. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND origination; client API
  • Example: 1234.56

application.requested_amount.currency

F0660 · string · Optional · Nullable: YesCurrency for requested amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND origination; client API
  • Example: CAD

application.requested_term_months

F0661 · integer · Optional · Nullable: YesRequested contractual term in months.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: 36

application.purpose

F0662 · string · Optional · Nullable: YesDeclared use of funds.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: Equipment purchase

application.submitted_at

F0663 · datetime · Optional · Nullable: YesApplication submission time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: Not specified

application.decision_id

F0664 · id · Optional · Nullable: YesCurrent decision artifact.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: dec_example

application.loan_id

F0665 · id · Optional · Nullable: YesResulting funded loan when one exists.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: null

application.guarantor_entity_ids[]

F0666 · array<id> · Optional · Nullable: YesProposed guarantors.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: []

application.collateral_ids[]

F0667 · array<id> · Optional · Nullable: YesOffered collateral.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: []

application.document_ids[]

F0668 · array<id> · Optional · Nullable: YesSubmitted application evidence.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: []

application.channel

F0669 · string · Optional · Nullable: YesBroker, direct, embedded or other source channel.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: direct

application.institution_reference

F0670 · string · Optional · Nullable: YesLender’s application reference.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND origination; client API
  • Example: APP-1001

credit_facility.borrower_entity_id

F0671 · id · Required · Nullable: NoObligated borrower.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: biz_example

credit_facility.product_type

F0672 · enum:credit_product · Required · Nullable: NoFacility product.
  • Format / enum / units: Enum: credit_product
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: line_of_credit

credit_facility.currency

F0673 · string · Optional · Nullable: YesContract currency.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: CAD

credit_facility.approved_limit.amount

F0674 · decimal · Optional · Nullable: YesCurrent approved facility limit. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

credit_facility.approved_limit.currency

F0675 · string · Optional · Nullable: YesCurrency for approved limit.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

credit_facility.drawn_amount.amount

F0676 · decimal · Optional · Nullable: YesOutstanding utilization reported by source. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

credit_facility.drawn_amount.currency

F0677 · string · Optional · Nullable: YesCurrency for drawn amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

credit_facility.available_amount.amount

F0678 · decimal · Optional · Nullable: YesUndrawn availability under the contract. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

credit_facility.available_amount.currency

F0679 · string · Optional · Nullable: YesCurrency for available amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

credit_facility.committed_amount.amount

F0680 · decimal · Optional · Nullable: YesCommitted portion of the facility. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

credit_facility.committed_amount.currency

F0681 · string · Optional · Nullable: YesCurrency for committed amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

credit_facility.effective_on

F0682 · date · Optional · Nullable: YesFacility effective date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2026-01-01

credit_facility.maturity_on

F0683 · date · Optional · Nullable: YesContractual end date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2027-01-01

credit_facility.review_due_on

F0684 · date · Optional · Nullable: YesNext scheduled credit review.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2026-12-01

credit_facility.status

F0685 · string · Optional · Nullable: YesSource facility state.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: active

credit_facility.loan_ids[]

F0686 · array<id> · Optional · Nullable: YesIndividual loans or draws governed by the facility.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: []

credit_facility.covenant_ids[]

F0687 · array<id> · Optional · Nullable: YesContractual monitoring covenants.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: []

loan.borrower_entity_id

F0688 · id · Required · Nullable: NoPrimary borrower.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: biz_example

loan.application_id

F0689 · id · Optional · Nullable: YesOriginating application if available.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: app_example

loan.facility_id

F0690 · id · Optional · Nullable: YesParent facility if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: fac_example

loan.product_type

F0691 · enum:credit_product · Required · Nullable: NoCredit product type.
  • Format / enum / units: Enum: credit_product
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: term_loan

loan.status

F0692 · enum:loan_status · Required · Nullable: NoServicing lifecycle state.
  • Format / enum / units: Enum: loan_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: active

loan.original_principal.amount

F0693 · decimal · Optional · Nullable: YesPrincipal at origination. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.original_principal.currency

F0694 · string · Optional · Nullable: YesCurrency for original principal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.outstanding_principal.amount

F0695 · decimal · Optional · Nullable: YesPrincipal still owed as of the balance date. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.outstanding_principal.currency

F0696 · string · Optional · Nullable: YesCurrency for outstanding principal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.accrued_interest.amount

F0697 · decimal · Optional · Nullable: YesAccrued unpaid interest separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.accrued_interest.currency

F0698 · string · Optional · Nullable: YesCurrency for accrued interest.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.fees_due.amount

F0699 · decimal · Optional · Nullable: YesUnpaid fees separately reported. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.fees_due.currency

F0700 · string · Optional · Nullable: YesCurrency for fees due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.total_payoff.amount

F0701 · decimal · Optional · Nullable: YesSource payoff quote including its calculation date. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.total_payoff.currency

F0702 · string · Optional · Nullable: YesCurrency for total payoff.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.annual_interest_rate

F0703 · decimal · Optional · Nullable: YesContractual annual rate expressed as a fraction.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: 9.5 percent is 0.095; not automatically APR.
  • Source families: LEND; client
  • Example: 0.095

loan.apr

F0704 · decimal · Optional · Nullable: YesDisclosed APR if explicitly supplied.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Do not relabel nominal rate as APR.
  • Source families: LEND; client
  • Example: null

loan.rate_type

F0705 · enum:rate_type · Optional · Nullable: YesFixed or variable interest arrangement.
  • Format / enum / units: Enum: rate_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: fixed

loan.benchmark

F0706 · string · Optional · Nullable: YesReference rate for variable pricing.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: null

loan.spread

F0707 · decimal · Optional · Nullable: YesMargin above benchmark, as a fraction.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 0.03

loan.interest_day_count

F0708 · string · Optional · Nullable: YesContractual day-count convention.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: actual_365

loan.payment_frequency

F0709 · enum:frequency · Optional · Nullable: YesScheduled payment cadence.
  • Format / enum / units: Enum: frequency
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: monthly

loan.scheduled_payment.amount

F0710 · decimal · Optional · Nullable: YesCurrent regular installment amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.scheduled_payment.currency

F0711 · string · Optional · Nullable: YesCurrency for scheduled payment.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.funded_on

F0712 · date · Optional · Nullable: YesInitial funding date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2026-01-15

loan.maturity_on

F0713 · date · Optional · Nullable: YesContract maturity.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2029-01-15

loan.next_payment_on

F0714 · date · Optional · Nullable: YesNext due installment date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2026-11-15

loan.days_past_due

F0715 · integer · Optional · Nullable: YesSource days-past-due under its servicing policy.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve policy and as-of date; no automatic recalculation from one missed item.
  • Source families: LEND; client
  • Example: 0

loan.past_due_amount.amount

F0716 · decimal · Optional · Nullable: YesContractual amount overdue. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.past_due_amount.currency

F0717 · string · Optional · Nullable: YesCurrency for past due amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.charged_off_amount.amount

F0718 · decimal · Optional · Nullable: YesAmount written off by the lender. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client
  • Example: 1234.56

loan.charged_off_amount.currency

F0719 · string · Optional · Nullable: YesCurrency for charged off amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client
  • Example: CAD

loan.as_of

F0720 · date · Required · Nullable: NoDate represented by balances and delinquency status.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: 2026-10-22

loan.autopay_enabled

F0721 · boolean · Optional · Nullable: YesSource-reported authorized automatic repayment setting.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client
  • Example: true

installment.loan_id

F0722 · id · Required · Nullable: NoParent loan.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND
  • Example: loa_example

installment.sequence_number

F0723 · integer · Optional · Nullable: YesContract schedule sequence.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND
  • Example: 10

installment.due_on

F0724 · date · Required · Nullable: NoInstallment due date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND
  • Example: 2026-11-15

installment.principal_due.amount

F0725 · decimal · Optional · Nullable: YesPrincipal due for this installment. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.principal_due.currency

F0726 · string · Optional · Nullable: YesCurrency for principal due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.interest_due.amount

F0727 · decimal · Optional · Nullable: YesInterest due for this installment. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.interest_due.currency

F0728 · string · Optional · Nullable: YesCurrency for interest due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.fees_due.amount

F0729 · decimal · Optional · Nullable: YesFees due for this installment. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.fees_due.currency

F0730 · string · Optional · Nullable: YesCurrency for fees due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.total_due.amount

F0731 · decimal · Optional · Nullable: YesTotal contractual obligation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.total_due.currency

F0732 · string · Optional · Nullable: YesCurrency for total due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.amount_paid.amount

F0733 · decimal · Optional · Nullable: YesApplied repayments against this obligation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.amount_paid.currency

F0734 · string · Optional · Nullable: YesCurrency for amount paid.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.remaining_due.amount

F0735 · decimal · Optional · Nullable: YesUnpaid scheduled obligation. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND
  • Example: 1234.56

installment.remaining_due.currency

F0736 · string · Optional · Nullable: YesCurrency for remaining due.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND
  • Example: CAD

installment.status

F0737 · enum:repayment_status · Optional · Nullable: YesSchedule or repayment state.
  • Format / enum / units: Enum: repayment_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND
  • Example: scheduled

repayment.loan_id

F0738 · id · Required · Nullable: NoLoan receiving the repayment.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: loa_example

repayment.installment_id

F0739 · id · Optional · Nullable: YesScheduled obligation if explicitly linked.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: ins_example

repayment.status

F0740 · enum:repayment_status · Required · Nullable: NoPayment execution state.
  • Format / enum / units: Enum: repayment_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: completed

repayment.amount.amount

F0741 · decimal · Optional · Nullable: YesTotal repayment amount. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client payment system
  • Example: 1234.56

repayment.amount.currency

F0742 · string · Optional · Nullable: YesCurrency for amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client payment system
  • Example: CAD

repayment.principal_applied.amount

F0743 · decimal · Optional · Nullable: YesAmount applied to principal. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client payment system
  • Example: 1234.56

repayment.principal_applied.currency

F0744 · string · Optional · Nullable: YesCurrency for principal applied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client payment system
  • Example: CAD

repayment.interest_applied.amount

F0745 · decimal · Optional · Nullable: YesAmount applied to interest. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client payment system
  • Example: 1234.56

repayment.interest_applied.currency

F0746 · string · Optional · Nullable: YesCurrency for interest applied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client payment system
  • Example: CAD

repayment.fees_applied.amount

F0747 · decimal · Optional · Nullable: YesAmount applied to fees. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client payment system
  • Example: 1234.56

repayment.fees_applied.currency

F0748 · string · Optional · Nullable: YesCurrency for fees applied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client payment system
  • Example: CAD

repayment.unapplied_amount.amount

F0749 · decimal · Optional · Nullable: YesCash received but not yet allocated. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client payment system
  • Example: 1234.56

repayment.unapplied_amount.currency

F0750 · string · Optional · Nullable: YesCurrency for unapplied amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client payment system
  • Example: CAD

repayment.received_at

F0751 · datetime · Optional · Nullable: YesTime funds were received.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: Not specified

repayment.effective_on

F0752 · date · Optional · Nullable: YesServicing value date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: 2026-10-15

repayment.method

F0753 · string · Optional · Nullable: YesPayment rail or method.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: preauthorized_debit

repayment.failure_code

F0754 · string · Optional · Nullable: YesReturn or failure reason when supplied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: null

repayment.bank_transaction_id

F0755 · id · Optional · Nullable: YesMatched bank movement when authorized.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: btx_example

repayment.reverses_repayment_id

F0756 · id · Optional · Nullable: YesRepayment reversed by this event.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client payment system
  • Example: null

collateral.loan_id

F0757 · id · Optional · Nullable: YesLoan secured or proposed to be secured.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: loa_example

collateral.facility_id

F0758 · id · Optional · Nullable: YesRelated credit facility.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: fac_example

collateral.collateral_type

F0759 · enum:collateral_type · Required · Nullable: NoAsset class.
  • Format / enum / units: Enum: collateral_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: equipment

collateral.description

F0760 · string · Optional · Nullable: YesDescription identifying the pledged asset.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: Industrial CNC machine

collateral.owner_entity_id

F0761 · id · Optional · Nullable: YesOwner evidenced for the asset.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: biz_example

collateral.serial_number

F0762 · string · Optional · Nullable: YesEquipment or asset serial number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: SERIAL-EXAMPLE

collateral.vin

F0763 · string · Optional · Nullable: YesVehicle identification number when relevant.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: null

collateral.property_identifier

F0764 · string · Optional · Nullable: YesLand parcel or title identifier when relevant.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: null

collateral.address

F0765 · Address · Optional · Nullable: YesLocation or real-property address.
  • Format / enum / units: Shared Types: Address
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: null

collateral.valuation.amount

F0766 · decimal · Optional · Nullable: YesValue established by a specified valuation source. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client; INV evidence
  • Example: 1234.56

collateral.valuation.currency

F0767 · string · Optional · Nullable: YesCurrency for valuation.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client; INV evidence
  • Example: CAD

collateral.valuation_date

F0768 · date · Optional · Nullable: YesDate of the valuation.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: 2026-09-01

collateral.valuation_method

F0769 · string · Optional · Nullable: YesAppraisal, book value or other stated method.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: independent_appraisal

collateral.appraiser

F0770 · string · Optional · Nullable: YesAppraiser or valuation provider.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: Example Appraisals

collateral.lien_ids[]

F0771 · array<id> · Optional · Nullable: YesRelated registrations or filings.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: []

collateral.advance_rate

F0772 · decimal · Optional · Nullable: YesLender-approved fraction eligible for borrowing base.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Contract parameter, not inferred from a registry filing.
  • Source families: LEND; client; INV evidence
  • Example: 0.70

collateral.insurance_expiry_on

F0773 · date · Optional · Nullable: YesExpiry of supporting insurance evidence.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; INV evidence
  • Example: 2027-01-01

guarantee.loan_id

F0774 · id · Optional · Nullable: YesGuaranteed loan.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: loa_example

guarantee.facility_id

F0775 · id · Optional · Nullable: YesGuaranteed facility.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: fac_example

guarantee.guarantor_entity_id

F0776 · id · Required · Nullable: NoPerson or entity providing the guarantee.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: per_example

guarantee.guarantee_type

F0777 · enum:guarantee_type · Optional · Nullable: YesNature of the guarantee.
  • Format / enum / units: Enum: guarantee_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: limited

guarantee.maximum_amount.amount

F0778 · decimal · Optional · Nullable: YesExplicit guarantee cap, if applicable. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND; client documents
  • Example: 1234.56

guarantee.maximum_amount.currency

F0779 · string · Optional · Nullable: YesCurrency for maximum amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND; client documents
  • Example: CAD

guarantee.signed_on

F0780 · date · Optional · Nullable: YesExecution date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: 2026-01-14

guarantee.expires_on

F0781 · date · Optional · Nullable: YesContractual expiry if one exists.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: null

guarantee.document_id

F0782 · id · Optional · Nullable: YesExecuted guarantee evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client documents
  • Example: doc_guarantee

covenant.facility_id

F0783 · id · Optional · Nullable: YesFacility subject to this covenant.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: fac_example

covenant.loan_id

F0784 · id · Optional · Nullable: YesLoan subject to this covenant.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: loa_example

covenant.name

F0785 · string · Required · Nullable: NoCovenant label.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: Minimum debt service coverage

covenant.attribute_key

F0786 · string · Optional · Nullable: YesMetric used by the test.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: dscr

covenant.operator

F0787 · string · Optional · Nullable: YesComparison operator.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Allowed: gt, gte, lt, lte, eq; compare only compatible types and units.
  • Source families: LEND; client; AMLOK derived
  • Example: gte

covenant.threshold

F0788 · decimal · Optional · Nullable: YesContractual threshold.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: 1.20

covenant.threshold_unit

F0789 · string · Optional · Nullable: YesUnit of threshold.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: ratio

covenant.observed_value

F0790 · decimal · Optional · Nullable: YesValue evaluated on this test date.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: 1.35

covenant.observed_on

F0791 · date · Optional · Nullable: YesDate the covenant was evaluated.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: 2026-09-30

covenant.status

F0792 · enum:covenant_status · Required · Nullable: NoTest outcome under the agreement.
  • Format / enum / units: Enum: covenant_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: compliant

covenant.waived_until

F0793 · date · Optional · Nullable: YesDocumented waiver expiry.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: null

covenant.evidence_document_id

F0794 · id · Optional · Nullable: YesAgreement or waiver establishing the rule.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND; client; AMLOK derived
  • Example: doc_facility

decision.application_id

F0795 · id · Optional · Nullable: YesCredit application assessed.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: app_example

decision.loan_id

F0796 · id · Optional · Nullable: YesExisting loan being reassessed.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: loa_example

decision.outcome

F0797 · enum:decision_outcome · Required · Nullable: NoRecorded outcome or recommendation.
  • Format / enum / units: Enum: decision_outcome
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: refer

decision.is_recommendation

F0798 · boolean · Required · Nullable: NoTrue if this is advisory and not an executed lender decision.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: true

decision.policy_id

F0799 · string · Optional · Nullable: YesInstitution policy applied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: policy_sme_ca

decision.policy_version

F0800 · string · Optional · Nullable: YesPolicy revision applied.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: 1.0.0

decision.approved_amount.amount

F0801 · decimal · Optional · Nullable: YesApproved or recommended amount with actor context. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Pair with currency; preserve precision; zero differs from unavailable.
  • Source families: LEND decision engines; client; AMLOK
  • Example: 1234.56

decision.approved_amount.currency

F0802 · string · Optional · Nullable: YesCurrency for approved amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: LEND decision engines; client; AMLOK
  • Example: CAD

decision.approved_term_months

F0803 · integer · Optional · Nullable: YesApproved or recommended term.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: 36

decision.reason_codes[]

F0804 · array<string> · Optional · Nullable: YesStructured reasons supporting the outcome.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: ["insufficient_history"]

decision.conditions[]

F0805 · array<string> · Optional · Nullable: YesConditions that must be satisfied.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: ["Obtain updated financials"]

decision.attribute_snapshot_id

F0806 · id · Optional · Nullable: YesImmutable risk evidence used in decisioning.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: rsk_example

decision.actor_id

F0807 · id · Optional · Nullable: YesInstitution user, service or agent responsible.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: usr_example

decision.decided_at

F0808 · datetime · Optional · Nullable: YesDecision timestamp.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: Not specified

decision.supersedes_decision_id

F0809 · id · Optional · Nullable: YesEarlier decision superseded by this one.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: LEND decision engines; client; AMLOK
  • Example: null

Liens

lien_search.debtor_name

F0810 · string · Required · Nullable: NoExact debtor name submitted for search.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: Example Manufacturing Inc.

lien_search.debtor_entity_id

F0811 · id · Optional · Nullable: YesResolved AMLOK debtor entity.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: biz_example

lien_search.debtor_type

F0812 · enum:party_type · Required · Nullable: NoPerson or business search subject.
  • Format / enum / units: Enum: party_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: business

lien_search.search_type

F0813 · string · Required · Nullable: NoName, registration number, VIN or serial search when supported.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: name

lien_search.identifier

F0814 · string · Optional · Nullable: YesSearch identifier if the chosen mode requires it.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: null

lien_search.jurisdictions_requested[]

F0815 · array<string> · Required · Nullable: NoJurisdictions explicitly requested.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ["US-DE"]

lien_search.jurisdictions_completed[]

F0816 · array<string> · Required · Nullable: NoJurisdictions actually completed.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ["US-DE"]

lien_search.status

F0817 · enum:search_status · Required · Nullable: NoSearch execution state.
  • Format / enum / units: Enum: search_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: completed

lien_search.searched_at

F0818 · datetime · Optional · Nullable: YesProvider search execution time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: Not specified

lien_search.effective_through

F0819 · datetime · Optional · Nullable: YesRegistry’s stated effective coverage time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Unknown does not mean current to the request time.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: null

lien_search.is_certified

F0820 · boolean · Optional · Nullable: YesWhether an official certified search was returned.
  • Format / enum / units: JSON boolean
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: API search output is not automatically certified.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: false

lien_search.search_logic

F0821 · string · Optional · Nullable: YesProvider or registry matching method.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: provider_defined

lien_search.result_count

F0822 · integer · Optional · Nullable: YesNumber of returned filings within completed scope.
  • Format / enum / units: JSON integer
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 2

lien_search.lien_ids[]

F0823 · array<id> · Optional · Nullable: YesNormalized filing results.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ["lie_example"]

lien_search.report_document_id

F0824 · id · Optional · Nullable: YesOriginal report or certificate.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: doc_lien

lien_search.processing_context

API contract field · ProcessingContext · RequiredAuthorized parent Insights workflow or paid Signal monitoring period. This stage is included in the product and creates no separate charge.See processing lifecycle and evidence traceability.

lien_search.stop_reason

API contract field · nullable · RequiredWhy unfinished processing stopped: account cancellation, parent cancellation, or revoked consent. Null when no stop applies.See processing lifecycle and evidence traceability.

lien.search_id

F0825 · id · Optional · Nullable: YesSearch that returned this record.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: lis_example

lien.filing_number

F0826 · string · Required · Nullable: NoRegistry-assigned filing or registration number.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: REG-1001

lien.original_filing_number

F0827 · string · Optional · Nullable: YesInitial registration in the filing chain.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: REG-1001

lien.lien_type

F0828 · enum:lien_type · Required · Nullable: NoLegal registry category.
  • Format / enum / units: Enum: lien_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ucc

lien.jurisdiction

F0829 · string · Required · Nullable: NoFiling jurisdiction.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: US-DE

lien.registry_name

F0830 · string · Optional · Nullable: YesRegistry of record.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: Example Secretary of State

lien.status

F0831 · enum:lien_status · Required · Nullable: NoSource-supported registration state.
  • Format / enum / units: Enum: lien_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Status is not a legal determination of enforceability or priority.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: active

lien.raw_status

F0832 · string · Optional · Nullable: YesUnmodified registry or provider status.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ACTIVE

lien.filed_on

F0833 · date · Optional · Nullable: YesFiling or registration date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 2024-04-01

lien.lapse_on

F0834 · date · Optional · Nullable: YesReported lapse date, if known.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 2029-04-01

lien.terminated_on

F0835 · date · Optional · Nullable: YesReported termination or discharge date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: null

lien.debtors[]

F0836 · array<LienParty> · Optional · Nullable: YesDebtors exactly as recorded, including unresolved parties.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: []

lien.secured_parties[]

F0837 · array<LienParty> · Optional · Nullable: YesSecured parties exactly as recorded.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: []

lien.collateral_description

F0838 · string · Optional · Nullable: YesRegistry’s collateral text when available.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: Equipment described in attached schedule

lien.collateral_categories[]

F0839 · array<string> · Optional · Nullable: YesSource or reviewed collateral classification.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: ["equipment"]

lien.is_blanket_lien

F0840 · boolean · Optional · Nullable: YesWhether evidence supports an all-assets description.
  • Format / enum / units: JSON boolean
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Null if collateral text is unavailable or ambiguous.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: null

lien.registered_amount.amount

F0841 · decimal · Optional · Nullable: YesAmount explicitly recorded by the registry, where applicable. Amount in major currency units.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: A UCC filing often has no debt amount; never treat missing amount as zero.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 1234.56

lien.registered_amount.currency

F0842 · string · Optional · Nullable: YesCurrency for registered amount.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: CAD

lien.currency_basis

F0843 · string · Optional · Nullable: YesMeaning of registered amount and currency as stated by source.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: registry_reported

lien.document_ids[]

F0844 · array<id> · Optional · Nullable: YesImages or reports supporting the filing.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: []

lien.match_disposition

F0845 · enum:match_disposition · Optional · Nullable: YesDebtor identity review result.
  • Format / enum / units: Enum: match_disposition
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: possible_match

lien.priority_assessment

F0846 · string · Optional · Nullable: YesSeparately reviewed priority conclusion, if commissioned.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage.
  • Normalization / validation: Never infer legal priority from filing date alone.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: null

filing_event.lien_id

F0847 · id · Required · Nullable: NoRegistration chain affected.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: lie_example

filing_event.event_type

F0848 · enum:filing_event_type · Required · Nullable: NoType of filing event.
  • Format / enum / units: Enum: filing_event_type
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: continuation

filing_event.filing_number

F0849 · string · Optional · Nullable: YesIdentifier of the specific event filing.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: REG-1002

filing_event.effective_on

F0850 · date · Optional · Nullable: YesEffective or recorded filing date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 2028-10-01

filing_event.previous_filing_number

F0851 · string · Optional · Nullable: YesPrior linked filing identifier if provided.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: REG-1001

filing_event.new_lapse_on

F0852 · date · Optional · Nullable: YesUpdated lapse date explicitly reported after this event.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: 2034-04-01

filing_event.description

F0853 · string · Optional · Nullable: YesSource event narrative.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: Continuation filed

filing_event.document_id

F0854 · id · Optional · Nullable: YesEvidence image or filing document.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK US registry services; AMLOK Canadian registry services; client registry reports
  • Example: doc_filing

Risk

attribute.key

F0855 · string · Required · Nullable: NoStable attribute name defined in Derived Attributes.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: operating_inflows

attribute.value_type

F0856 · enum:value_type · Required · Nullable: NoType of the value.
  • Format / enum / units: Enum: value_type
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: decimal

attribute.value

F0857 · string · Optional · Nullable: YesSerialized scalar value matching value_type.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Null if required inputs or coverage are missing.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: 50000.00

attribute.unit

F0858 · string · Required · Nullable: NoCurrency, ratio, days, count or other explicit unit.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: CAD

attribute.status

F0859 · enum:metric_status · Required · Nullable: NoWhether this value is usable for its stated interval.
  • Format / enum / units: Enum: metric_status
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: available

attribute.window_start

F0860 · date · Required · Nullable: NoInclusive measurement interval start.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: 2026-09-01

attribute.window_end

F0861 · date · Required · Nullable: NoExclusive measurement interval end.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: 2026-10-01

attribute.as_of

F0862 · datetime · Required · Nullable: NoLatest evidence included in calculation.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: Not specified

attribute.calculation_version

F0863 · string · Required · Nullable: NoVersioned formula or feature definition.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: cashflow-v1

attribute.input_resource_ids[]

F0864 · array<id> · Required · Nullable: NoSupporting records or immutable manifest reference.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: []

attribute.coverage_ratio

F0865 · decimal · Optional · Nullable: YesFraction of expected time/account coverage actually available.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: 0 to 1; null when denominator cannot be defined.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: 1.0

attribute.missing_reason

F0866 · enum:null_reason · Optional · Nullable: YesReason value is null.
  • Format / enum / units: Enum: null_reason
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: null

attribute.provider_score_scale

F0867 · string · Optional · Nullable: YesNative scale for licensed scores, if relevant.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK derived; licensed provider analytics
  • Example: null

risk_snapshot.assessment_type

F0868 · string · Required · Nullable: NoAssessment purpose or workflow.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: underwriting

risk_snapshot.as_of

F0869 · datetime · Required · Nullable: NoEvidence cutoff used by this assessment.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

risk_snapshot.attribute_ids[]

F0870 · array<id> · Required · Nullable: NoValues used in the assessment.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: ["atr_example"]

risk_snapshot.previous_snapshot_id

F0871 · id · Optional · Nullable: YesEarlier comparable assessment.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.model_id

F0872 · string · Optional · Nullable: YesModel used if a score was generated.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.model_version

F0873 · string · Optional · Nullable: YesExact model revision.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.score

F0874 · decimal · Optional · Nullable: YesModel-specific score; unavailable until model is validated and entitled.
  • Format / enum / units: Decimal string; no exponent; no binary float arithmetic
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.score_scale

F0875 · string · Optional · Nullable: YesMeaning and allowed range of the model score.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.rating

F0876 · string · Optional · Nullable: YesPolicy-specific risk category.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK derived
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

risk_snapshot.reason_codes[]

F0877 · array<string> · Optional · Nullable: YesExplanatory factors tied to evidence.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: []

risk_snapshot.evidence_manifest_id

F0878 · string · Required · Nullable: NoImmutable list of input record versions.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: manifest_example

risk_snapshot.workflow_run_id

API contract field · string · RequiredWorkflow that produced this assessment output.See processing lifecycle and evidence traceability.

risk_snapshot.application_id

API contract field · nullable · RequiredAssociated underwriting application, when applicable.See processing lifecycle and evidence traceability.

risk_snapshot.billing_usage_id

API contract field · nullable · RequiredThe one successful product charge associated with the result. Null before charging, or for an included stage with no separate charge.See processing lifecycle and evidence traceability.

monitor.baseline_snapshot_id

F0879 · id · Required · Nullable: NoOriginal assessment used for change detection.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: rsk_original

monitor.resource_types[]

F0880 · array<string> · Required · Nullable: NoResources monitored under this subscription.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: ["bank_transaction","lien"]

monitor.attribute_keys[]

F0881 · array<string> · Required · Nullable: NoTracked calculated attributes.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: ["operating_inflows"]

monitor.status

F0882 · enum:monitor_status · Required · Nullable: NoMonitoring subscription state.
  • Format / enum / units: Enum: monitor_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: active

monitor.cadence

F0883 · string · Required · Nullable: NoRequested refresh schedule, subject to source capability.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: daily

monitor.ruleset_version

F0884 · string · Required · Nullable: NoVersion of alert thresholds and conditions.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: monitor-v1

monitor.last_evaluated_at

F0885 · datetime · Optional · Nullable: YesLatest successful evaluation.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: Not specified

monitor.next_evaluation_at

F0886 · datetime · Optional · Nullable: YesNext planned evaluation.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; contracted provider monitoring
  • Example: Not specified

monitor.blocked_reason

API contract field · nullable · RequiredReason processing cannot continue. Null when unblocked. Inspect the enum and processing lifecycle before retrying.See processing lifecycle and evidence traceability.

monitor.monitoring_period_id

API contract field · nullable · RequiredShared borrower/business/workspace UTC calendar month. Null for Insights.See processing lifecycle and evidence traceability.

alert.monitor_id

F0887 · id · Optional · Nullable: YesMonitoring configuration generating the alert.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: mon_example

alert.alert_type

F0888 · string · Required · Nullable: NoVersioned signal key.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: operating_inflows_decline

alert.severity

F0889 · enum:severity · Required · Nullable: NoPolicy-assigned severity.
  • Format / enum / units: Enum: severity
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: high

alert.status

F0890 · enum:alert_status · Required · Nullable: NoOperational review state.
  • Format / enum / units: Enum: alert_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: open

alert.detected_at

F0891 · datetime · Required · Nullable: NoTime the signal was detected.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: Not specified

alert.baseline_snapshot_id

F0892 · id · Optional · Nullable: YesReference assessment.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: rsk_original

alert.current_snapshot_id

F0893 · id · Optional · Nullable: YesAssessment showing the change.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: rsk_current

alert.attribute_key

F0894 · string · Optional · Nullable: YesMetric underlying the signal.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: operating_inflows

alert.previous_value

F0895 · string · Optional · Nullable: YesPrior comparable scalar value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: 50000.00

alert.current_value

F0896 · string · Optional · Nullable: YesCurrent comparable scalar value.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: 35000.00

alert.threshold

F0897 · string · Optional · Nullable: YesRule threshold that was crossed.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: relative_change <= -0.25

alert.reason

F0898 · string · Optional · Nullable: YesEvidence-based explanation.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: Operating inflows declined over comparable covered windows.

alert.evidence_ids[]

F0899 · array<id> · Optional · Nullable: YesSupporting records or documents.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: []

alert.resolved_at

F0901 · datetime · Optional · Nullable: YesTime the alert was resolved or dismissed.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; provider alerts
  • Example: null

Operations

workflow_run.workflow_type

F0946 · enum:workflow_type · Required · Nullable: NoRisk workflow category.
  • Format / enum / units: Enum: workflow_type
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: verify

workflow_run.workflow_version

F0947 · string · Required · Nullable: NoVersion of the orchestration definition.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: verify-v1

workflow_run.status

F0948 · enum:workflow_status · Required · Nullable: NoExecution state.
  • Format / enum / units: Enum: workflow_status
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: waiting_for_data

workflow_run.application_id

F0949 · id · Optional · Nullable: YesApplication context if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: app_example

workflow_run.loan_id

F0950 · id · Optional · Nullable: YesLoan context if applicable.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

workflow_run.input_resource_ids[]

F0951 · array<id> · Required · Nullable: NoImmutable input references.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: []

workflow_run.output_resource_ids[]

F0952 · array<id> · Required · Nullable: NoProduced assessments, checks, risk findings or reports.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: []

workflow_run.started_at

F0954 · datetime · Optional · Nullable: YesExecution start.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

workflow_run.completed_at

F0955 · datetime · Optional · Nullable: YesTerminal completion time.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

workflow_run.parent_run_id

F0956 · id · Optional · Nullable: YesParent assessment run. Signal reassessment remains included in Signal.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: null

workflow_run.product

API contract field · string · RequiredInsights for full underwriting or its stages; Signal for monitoring and included reassessment.See processing lifecycle and evidence traceability.

workflow_run.input_manifest_id

API contract field · string · RequiredImmutable evidence manifest used for this run, including exact source record versions.See processing lifecycle and evidence traceability.

workflow_run.initial_input_manifest_id

API contract field · string · RequiredInitial immutable manifest retained when accepted missing evidence creates a successor for an unfinished run. Audit events identify every replacement; completed outputs remain immutable.See processing lifecycle and evidence traceability.

workflow_run.workload_id

API contract field · string · RequiredRead-only workload report with observed counts and agreed limits.See processing lifecycle and evidence traceability.

workflow_run.billing_usage_id

API contract field · nullable · RequiredThe one successful product charge associated with the result. Null before charging, or for an included stage with no separate charge.See processing lifecycle and evidence traceability.

workflow_run.monitoring_period_id

API contract field · nullable · RequiredShared borrower/business/workspace UTC calendar month. Null for Insights.See processing lifecycle and evidence traceability.

workflow_run.blocked_reason

API contract field · nullable · RequiredReason processing cannot continue. Null when unblocked. Inspect the enum and processing lifecycle before retrying.See processing lifecycle and evidence traceability.

workflow_run.stop_reason

API contract field · nullable · RequiredWhy unfinished processing stopped: account cancellation, parent cancellation, or revoked consent. Null when no stop applies.See processing lifecycle and evidence traceability.

requirement.workflow_run_id

F0958 · id · Required · Nullable: NoRun requiring this evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: wfr_example

requirement.requirement_type

F0959 · string · Required · Nullable: NoRequested evidence category.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: bank_statement

requirement.description

F0960 · string · Required · Nullable: NoSpecific evidence requirement.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: Most recent three complete bank statements

requirement.status

F0961 · enum:requirement_status · Required · Nullable: NoCollection and review status.
  • Format / enum / units: Enum: requirement_status
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: requested

requirement.due_on

F0962 · date · Optional · Nullable: YesRequested completion date.
  • Format / enum / units: YYYY-MM-DD, preserve source calendar date
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: 2026-10-25

requirement.document_ids[]

F0963 · array<id> · Optional · Nullable: YesEvidence submitted for this requirement.
  • Format / enum / units: JSON array; [] only when known empty
  • Origin: Normalized source
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: []

requirement.reviewer_id

F0964 · id · Optional · Nullable: YesReviewer accepting or rejecting evidence.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: null

requirement.waiver_reason

F0965 · string · Optional · Nullable: YesDocumented basis for a permitted waiver.
  • Format / enum / units: UTF-8 string
  • Origin: Normalized source
  • Classification: Restricted
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK; LEND
  • Example: null

audit_event.actor_id

F0966 · string · Required · Nullable: NoUser, API client or agent responsible.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Restricted
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: client_example

audit_event.actor_type

F0967 · string · Required · Nullable: NoClass of principal.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: api_client

audit_event.action

F0968 · string · Required · Nullable: NoAction performed.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: verification.created

audit_event.resource_type

F0969 · string · Required · Nullable: NoType of affected object.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: verification

audit_event.resource_id

F0970 · id · Required · Nullable: NoAffected object.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: ver_example

audit_event.resource_version

F0971 · integer · Optional · Nullable: YesVersion observed or produced.
  • Format / enum / units: JSON integer
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: 1

audit_event.occurred_at

F0972 · datetime · Required · Nullable: NoAction timestamp.
  • Format / enum / units: RFC 3339 UTC; retain source timezone in provenance
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: Not specified

audit_event.request_id

F0973 · string · Required · Nullable: NoRequest correlation identifier.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: req_example

audit_event.workflow_run_id

F0974 · id · Optional · Nullable: YesRelated orchestration run.
  • Format / enum / units: Opaque AMLOK identifier
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: wfr_example

audit_event.outcome

F0975 · string · Required · Nullable: NoSuccess, denial or failure result.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Required when resource exists
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: success

audit_event.change_summary

F0976 · string · Optional · Nullable: YesDescription of changed fields without sensitive raw values.
  • Format / enum / units: UTF-8 string
  • Origin: AMLOK managed
  • Classification: Confidential
  • Availability: Source, module, country, consent and contracted permissions determine population.
  • Normalization / validation: Preserve original evidence; do not invent missing values.
  • Source families: AMLOK
  • Example: status changed