Payload field reference
Generated from om-0.1.schema.json (openOM payload 0.1).
✓ marks required fields.
| Field | Type | Req | Description |
|---|---|---|---|
@context | array<string> | ✓ | schema.org + the openOM namespace https://openom.app/ns/0.1 (vocabulary published at spec/context/openom-0.1.jsonld). |
@type | any | ✓ | |
specVersion | any | ✓ | |
currency | string | ISO 4217; default USD when absent ([OM-DD-002]). | |
assertedBy | object | ✓ | |
assertedBy.broker | string | ✓ | |
assertedBy.brokerage | string | ✓ | |
assertedBy.license | string | ✓ | |
assertedBy.website | string | OPTIONAL (#118). The asserting party's website - the identity anchor §10 layer-3 origin verification binds to. Reserved for the registry-era license↔domain↔key cross-check. | |
assertedBy.licenseJurisdiction | string | OPTIONAL (#118). ISO 3166-1/-2 code (e.g. US, US-CA) disambiguating the license number's authority space for worldwide use. | |
assertedBy.licenseAuthority | string | OPTIONAL (#118). Name of the issuing licensing authority. | |
assertedDate | string | ✓ | |
property | object | ||
property.propertyType | string | OPTIONAL (#114). Extensible discriminator: retail | office | industrial | multifamily | land | mixed-use | hospitality | self-storage | other. Open string in 0.1; 0.2 may formalize the enum. | |
property.address | object | ||
property.address.streetAddress | string | ||
property.address.addressLocality | string | ||
property.address.addressRegion | string | ||
property.address.postalCode | string | ||
property.address.addressCountry | string | ||
property.geo | object | ||
property.geo.latitude | number | ||
property.geo.longitude | number | ||
property.apn | string | ||
property.buildingSF | number | ||
property.lotAcres | number | ||
property.yearBuilt | integer | ||
property.yearRenovated | integer | ||
property.units | integer | OPTIONAL. Total rentable units (multifamily / mixed-use). | |
property.occupancy | number | OPTIONAL. Occupancy as a decimal fraction (0.95 = 95%), matching the capRate fraction convention. | |
deal | object | ||
deal.askingPrice | number | ||
deal.capRate | number | ||
deal.noi | number | ||
deal.noiType | enum(in-place, pro-forma) | ||
deal.noiAsOfDate | string | ||
deal.pricePerSF | number | ||
deal.pricePerUnit | number | OPTIONAL. Asking price per unit (multifamily analog of pricePerSF). | |
deal.status | enum(active, under-contract, sold, withdrawn) | ||
lease | object | ||
lease.tenantEntity | string | ||
lease.guarantor | object | ||
lease.guarantor.name | string | ||
lease.guarantor.type | enum(corporate, franchisee, personal, none) | ||
lease.landlordResponsibilities | object | ||
lease.landlordResponsibilities.roof | boolean | ||
lease.landlordResponsibilities.structure | boolean | ||
lease.landlordResponsibilities.parking | boolean | ||
lease.landlordResponsibilities.hvac | boolean | ||
lease.landlordResponsibilities.taxes | boolean | ||
lease.landlordResponsibilities.insurance | boolean | ||
lease.landlordResponsibilities.cam | boolean | ||
lease.leaseTypeAsserted | enum(N, NN, NNN, absolute-net, gross, modified-gross) | ||
lease.commencement | string | ||
lease.expiration | string | ||
lease.termMonths | number | Stated total lease term in months; cross-checked against expiration - commencement (OMW-W031). | |
lease.remainingTermMonths | number | Stated remaining term in months as of assertedDate; cross-checked against expiration - as_of (OMW-W030). | |
lease.rentSchedule | array<rentPeriod> | ||
lease.options | array<object> | ||
meta | object | ✓ | |
meta.sourceDocHash | sha256OrNull | ||
meta.supersedes | sha256OrNull | ✓ | |
meta.signature | any | Reserved (#117, §11.1 layer-4). Either null/absent OR the {alg,keyId,value} envelope. 0.1 consumers MUST IGNORE a populated value (no trust weight); it is excluded from the integrity preimage ([OM-CANON-003]) so it stays additive. A value that is neither null nor the reserved shape is OMV-E003. | |
meta.imageRights | string | ||
ext | object | OPTIONAL (#115). The ONLY place non-standard/vendor fields belong - namespaced by vendor (e.g. `"ext": { "acme": { ... } }`) so they never collide with future core terms. 0.1 tools preserve it and MUST NOT interpret it. |