IF Commons GitHub

sql/typed/models/arca-party.auto

The typed tables of the arcaParty model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.

The people and organizations a business deals with, how they relate, what roles they play, how they are identified and how they are reached

Source: commons/data/sql/typed/models/arca-party.auto.ts

0 of 48 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

arcaPartynamespace
namespace arcaParty
arcaParty.PartyKindRowinterfaceno test imports it
interface PartyKindRow

The kinds of party: a person or an organization

MemberTypeWhat it is
codestringThe code other tables point to: a short word that does not change
labelstringWhat a person is shown for the code
descriptionstring | nullWhat the code means, where the label is not enough
arcaParty.PartyKindInsertinterfaceno test imports it
interface PartyKindInsert

What an insert into party_kind takes: what the database fills may be left out.

MemberTypeWhat it is
codestring
labelstring
description?string | null
arcaParty.PartyKindKeytypeno test imports it
type PartyKindKey = { readonly code: string };

The key of a row of party_kind.

arcaParty.partyKindconstno test imports it
const partyKind: Table<PartyKindRow, PartyKindInsert, "partyKind">

The kinds of party: a person or an organization

arcaParty.PartyRoleKindRowinterfaceno test imports it
interface PartyRoleKindRow

The roles a party may play, such as customer, supplier or employee

MemberTypeWhat it is
codestringThe code other tables point to: a short word that does not change
labelstringWhat a person is shown for the code
descriptionstring | nullWhat the code means, where the label is not enough
arcaParty.PartyRoleKindInsertinterfaceno test imports it
interface PartyRoleKindInsert

What an insert into party_role_kind takes: what the database fills may be left out.

MemberTypeWhat it is
codestring
labelstring
description?string | null
arcaParty.PartyRoleKindKeytypeno test imports it
type PartyRoleKindKey = { readonly code: string };

The key of a row of party_role_kind.

arcaParty.partyRoleKindconstno test imports it
const partyRoleKind: Table<PartyRoleKindRow, PartyRoleKindInsert, "partyRoleKind">

The roles a party may play, such as customer, supplier or employee

arcaParty.PartyRelationKindRowinterfaceno test imports it
interface PartyRelationKindRow

The ways one party may be related to another

MemberTypeWhat it is
codestringThe code other tables point to: a short word that does not change
labelstringWhat a person is shown for the code
descriptionstring | nullWhat the code means, where the label is not enough
arcaParty.PartyRelationKindInsertinterfaceno test imports it
interface PartyRelationKindInsert

What an insert into party_relation_kind takes: what the database fills may be left out.

MemberTypeWhat it is
codestring
labelstring
description?string | null
arcaParty.PartyRelationKindKeytypeno test imports it
type PartyRelationKindKey = { readonly code: string };

The key of a row of party_relation_kind.

arcaParty.partyRelationKindconstno test imports it
const partyRelationKind: Table<PartyRelationKindRow, PartyRelationKindInsert, "partyRelationKind">

The ways one party may be related to another

arcaParty.PartyIdentifierKindRowinterfaceno test imports it
interface PartyIdentifierKindRow

The kinds of identifier a party may hold

MemberTypeWhat it is
codestringThe code other tables point to: a short word that does not change
labelstringWhat a person is shown for the code
descriptionstring | nullWhat the code means, where the label is not enough
arcaParty.PartyIdentifierKindInsertinterfaceno test imports it
interface PartyIdentifierKindInsert

What an insert into party_identifier_kind takes: what the database fills may be left out.

MemberTypeWhat it is
codestring
labelstring
description?string | null
arcaParty.PartyIdentifierKindKeytypeno test imports it
type PartyIdentifierKindKey = { readonly code: string };

The key of a row of party_identifier_kind.

arcaParty.partyIdentifierKindconstno test imports it
const partyIdentifierKind: Table<PartyIdentifierKindRow, PartyIdentifierKindInsert, "partyIdentifierKind">

The kinds of identifier a party may hold

arcaParty.PartyRowinterfaceno test imports it
interface PartyRow

Anyone or anything a business deals with as one, whether a person or an organization

MemberTypeWhat it is
partyIdstringWhat identifies the party, made by the application when the party is created
partyKindCodestringWhether the party is a person or an organization
displayNamestringThe name the party is shown by, whatever its parts are
arcaParty.PartyInsertinterfaceno test imports it
interface PartyInsert

What an insert into party takes: what the database fills may be left out.

MemberTypeWhat it is
partyIdstring
partyKindCodestring
displayNamestring
arcaParty.PartyKeytypeno test imports it
type PartyKey = { readonly partyId: string };

The key of a row of party.

arcaParty.partyconstno test imports it
const party: Table<PartyRow, PartyInsert, "party">

Anyone or anything a business deals with as one, whether a person or an organization

arcaParty.PersonRowinterfaceno test imports it
interface PersonRow

A party who is a human being; what is true of a person and not of every party

MemberTypeWhat it is
partyIdstringThe party the person is
givenNamestringThe name a person is given, as they write it
familyNamestringThe name a person shares with their family, as they write it
birthDatestring | nullThe day the person was born
arcaParty.PersonInsertinterfaceno test imports it
interface PersonInsert

What an insert into person takes: what the database fills may be left out.

MemberTypeWhat it is
partyIdstring
givenNamestring
familyNamestring
birthDate?string | null
arcaParty.PersonKeytypeno test imports it
type PersonKey = { readonly partyId: string };

The key of a row of person.

arcaParty.personconstno test imports it
const person: Table<PersonRow, PersonInsert, "person">

A party who is a human being; what is true of a person and not of every party

arcaParty.OrganizationRowinterfaceno test imports it
interface OrganizationRow

A party that is a company, an agency, a club or any other body

MemberTypeWhat it is
partyIdstringThe party the organization is
legalNamestringThe name the organization is registered under
foundedOnstring | nullThe day the organization was founded
arcaParty.OrganizationInsertinterfaceno test imports it
interface OrganizationInsert

What an insert into organization takes: what the database fills may be left out.

MemberTypeWhat it is
partyIdstring
legalNamestring
foundedOn?string | null
arcaParty.OrganizationKeytypeno test imports it
type OrganizationKey = { readonly partyId: string };

The key of a row of organization.

arcaParty.organizationconstno test imports it
const organization: Table<OrganizationRow, OrganizationInsert, "organization">

A party that is a company, an agency, a club or any other body

arcaParty.PartyRoleRowinterfaceno test imports it
interface PartyRoleRow

A role a party plays for a time: the same party may be a customer and a supplier at once

MemberTypeWhat it is
partyRoleIdstringWhat identifies this playing of a role
partyRoleKindCodestringThe role played
validFromstringThe first day the party played the role
validTostring | nullThe last day the party played the role; empty while they still do
partyIdstringThe party who plays the role
arcaParty.PartyRoleInsertinterfaceno test imports it
interface PartyRoleInsert

What an insert into party_role takes: what the database fills may be left out.

MemberTypeWhat it is
partyRoleIdstring
partyRoleKindCodestring
validFromstring
validTo?string | null
partyIdstring
arcaParty.PartyRoleKeytypeno test imports it
type PartyRoleKey = { readonly partyRoleId: string };

The key of a row of party_role.

arcaParty.partyRoleconstno test imports it
const partyRole: Table<PartyRoleRow, PartyRoleInsert, "partyRole">

A role a party plays for a time: the same party may be a customer and a supplier at once

arcaParty.PartyRelationRowinterfaceno test imports it
interface PartyRelationRow

A relation between two parties for a time, read from the first to the second: Ada is employed by Analytical Engines

MemberTypeWhat it is
partyRelationIdstringWhat identifies the relation
partyRelationKindCodestringThe way the first party is related to the second
validFromstringThe first day the relation held
validTostring | nullThe last day the relation held; empty while it still does
fromPartyIdstringThe party the relation is read from
toPartyIdstringThe party the relation is read to
arcaParty.PartyRelationInsertinterfaceno test imports it
interface PartyRelationInsert

What an insert into party_relation takes: what the database fills may be left out.

MemberTypeWhat it is
partyRelationIdstring
partyRelationKindCodestring
validFromstring
validTo?string | null
fromPartyIdstring
toPartyIdstring
arcaParty.PartyRelationKeytypeno test imports it
type PartyRelationKey = { readonly partyRelationId: string };

The key of a row of party_relation.

arcaParty.partyRelationconstno test imports it
const partyRelation: Table<PartyRelationRow, PartyRelationInsert, "partyRelation">

A relation between two parties for a time, read from the first to the second: Ada is employed by Analytical Engines

arcaParty.PartyIdentifierRowinterfaceno test imports it
interface PartyIdentifierRow

An identifier a party holds, as someone else issued it: a tax number, a passport number; a party holds one of a kind once

MemberTypeWhat it is
partyIdentifierIdstringWhat identifies the identifier as Arca keeps it
partyIdentifierKindCodestringThe kind of identifier
identifierstringThe identifier itself, as it was issued
issuedBystring | nullWho issued the identifier
partyIdstringThe party who holds the identifier
arcaParty.PartyIdentifierInsertinterfaceno test imports it
interface PartyIdentifierInsert

What an insert into party_identifier takes: what the database fills may be left out.

MemberTypeWhat it is
partyIdentifierIdstring
partyIdentifierKindCodestring
identifierstring
issuedBy?string | null
partyIdstring
arcaParty.PartyIdentifierKeytypeno test imports it
type PartyIdentifierKey = { readonly partyIdentifierId: string };

The key of a row of party_identifier.

arcaParty.partyIdentifierconstno test imports it
const partyIdentifier: Table<PartyIdentifierRow, PartyIdentifierInsert, "partyIdentifier">

An identifier a party holds, as someone else issued it: a tax number, a passport number; a party holds one of a kind once

arcaParty.ElectronicContactRowinterfaceno test imports it
interface ElectronicContactRow

A way to reach a party over a network: an email address, a telephone number, a web address

MemberTypeWhat it is
electronicContactIdstringWhat identifies the contact point
medium"email" | "telephone" | "web"Whether this is an email address, a telephone number or a web address
addressstringThe address or number itself
isPrimarybooleanWhether this is the first way to try for its medium
partyIdstringThe party reached this way
arcaParty.ElectronicContactInsertinterfaceno test imports it
interface ElectronicContactInsert

What an insert into electronic_contact takes: what the database fills may be left out.

MemberTypeWhat it is
electronicContactIdstring
medium"email" | "telephone" | "web"
addressstring
isPrimary?boolean
partyIdstring
arcaParty.ElectronicContactKeytypeno test imports it
type ElectronicContactKey = { readonly electronicContactId: string };

The key of a row of electronic_contact.

arcaParty.electronicContactconstno test imports it
const electronicContact: Table<ElectronicContactRow, ElectronicContactInsert, "electronicContact">

A way to reach a party over a network: an email address, a telephone number, a web address

arcaParty.PostalAddressRowinterfaceno test imports it
interface PostalAddressRow

A place a party receives post or may be visited

MemberTypeWhat it is
postalAddressIdstringWhat identifies the address
purpose"billing" | "delivery" | "home" | "work"What the address is used for: where the party lives, is billed or receives deliveries
line1stringThe first line: usually the building and the street
line2string | nullThe second line, where there is one
localitystringThe town or city
regionstring | nullThe state, province or county, where the country uses one
postalCodestring | nullThe postal code, where the country uses one
countryCodestringThe country, as its two-letter ISO 3166-1 code
partyIdstringThe party found at the address
arcaParty.PostalAddressInsertinterfaceno test imports it
interface PostalAddressInsert

What an insert into postal_address takes: what the database fills may be left out.

MemberTypeWhat it is
postalAddressIdstring
purpose"billing" | "delivery" | "home" | "work"
line1string
line2?string | null
localitystring
region?string | null
postalCode?string | null
countryCodestring
partyIdstring
arcaParty.PostalAddressKeytypeno test imports it
type PostalAddressKey = { readonly postalAddressId: string };

The key of a row of postal_address.

arcaParty.postalAddressconstno test imports it
const postalAddress: Table<PostalAddressRow, PostalAddressInsert, "postalAddress">

A place a party receives post or may be visited

Titles, headings, exports, tables, columns and requirements. Esc closes.