arcaPartynamespacenamespace arcaPartyThe 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
arcaPartynamespacenamespace arcaPartyarcaParty.PartyKindRowinterfaceno test imports itinterface PartyKindRowThe kinds of party: a person or an organization
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
arcaParty.PartyKindInsertinterfaceno test imports itinterface PartyKindInsertWhat an insert into party_kind takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
arcaParty.PartyKindKeytypeno test imports ittype PartyKindKey = { readonly code: string };The key of a row of party_kind.
arcaParty.partyKindconstno test imports itconst partyKind: Table<PartyKindRow, PartyKindInsert, "partyKind">The kinds of party: a person or an organization
arcaParty.PartyRoleKindRowinterfaceno test imports itinterface PartyRoleKindRowThe roles a party may play, such as customer, supplier or employee
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
arcaParty.PartyRoleKindInsertinterfaceno test imports itinterface PartyRoleKindInsertWhat an insert into party_role_kind takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
arcaParty.PartyRoleKindKeytypeno test imports ittype PartyRoleKindKey = { readonly code: string };The key of a row of party_role_kind.
arcaParty.partyRoleKindconstno test imports itconst partyRoleKind: Table<PartyRoleKindRow, PartyRoleKindInsert, "partyRoleKind">The roles a party may play, such as customer, supplier or employee
arcaParty.PartyRelationKindRowinterfaceno test imports itinterface PartyRelationKindRowThe ways one party may be related to another
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
arcaParty.PartyRelationKindInsertinterfaceno test imports itinterface PartyRelationKindInsertWhat an insert into party_relation_kind takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
arcaParty.PartyRelationKindKeytypeno test imports ittype PartyRelationKindKey = { readonly code: string };The key of a row of party_relation_kind.
arcaParty.partyRelationKindconstno test imports itconst partyRelationKind: Table<PartyRelationKindRow, PartyRelationKindInsert, "partyRelationKind">The ways one party may be related to another
arcaParty.PartyIdentifierKindRowinterfaceno test imports itinterface PartyIdentifierKindRowThe kinds of identifier a party may hold
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
arcaParty.PartyIdentifierKindInsertinterfaceno test imports itinterface PartyIdentifierKindInsertWhat an insert into party_identifier_kind takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
arcaParty.PartyIdentifierKindKeytypeno test imports ittype PartyIdentifierKindKey = { readonly code: string };The key of a row of party_identifier_kind.
arcaParty.partyIdentifierKindconstno test imports itconst partyIdentifierKind: Table<PartyIdentifierKindRow, PartyIdentifierKindInsert, "partyIdentifierKind">The kinds of identifier a party may hold
arcaParty.PartyRowinterfaceno test imports itinterface PartyRowAnyone or anything a business deals with as one, whether a person or an organization
| Member | Type | What it is |
|---|---|---|
partyId | string | What identifies the party, made by the application when the party is created |
partyKindCode | string | Whether the party is a person or an organization |
displayName | string | The name the party is shown by, whatever its parts are |
arcaParty.PartyInsertinterfaceno test imports itinterface PartyInsertWhat an insert into party takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyId | string | |
partyKindCode | string | |
displayName | string |
arcaParty.PartyKeytypeno test imports ittype PartyKey = { readonly partyId: string };The key of a row of party.
arcaParty.partyconstno test imports itconst party: Table<PartyRow, PartyInsert, "party">Anyone or anything a business deals with as one, whether a person or an organization
arcaParty.PersonRowinterfaceno test imports itinterface PersonRowA party who is a human being; what is true of a person and not of every party
| Member | Type | What it is |
|---|---|---|
partyId | string | The party the person is |
givenName | string | The name a person is given, as they write it |
familyName | string | The name a person shares with their family, as they write it |
birthDate | string | null | The day the person was born |
arcaParty.PersonInsertinterfaceno test imports itinterface PersonInsertWhat an insert into person takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyId | string | |
givenName | string | |
familyName | string | |
birthDate? | string | null |
arcaParty.PersonKeytypeno test imports ittype PersonKey = { readonly partyId: string };The key of a row of person.
arcaParty.personconstno test imports itconst 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 itinterface OrganizationRowA party that is a company, an agency, a club or any other body
| Member | Type | What it is |
|---|---|---|
partyId | string | The party the organization is |
legalName | string | The name the organization is registered under |
foundedOn | string | null | The day the organization was founded |
arcaParty.OrganizationInsertinterfaceno test imports itinterface OrganizationInsertWhat an insert into organization takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyId | string | |
legalName | string | |
foundedOn? | string | null |
arcaParty.OrganizationKeytypeno test imports ittype OrganizationKey = { readonly partyId: string };The key of a row of organization.
arcaParty.organizationconstno test imports itconst organization: Table<OrganizationRow, OrganizationInsert, "organization">A party that is a company, an agency, a club or any other body
arcaParty.PartyRoleRowinterfaceno test imports itinterface PartyRoleRowA role a party plays for a time: the same party may be a customer and a supplier at once
| Member | Type | What it is |
|---|---|---|
partyRoleId | string | What identifies this playing of a role |
partyRoleKindCode | string | The role played |
validFrom | string | The first day the party played the role |
validTo | string | null | The last day the party played the role; empty while they still do |
partyId | string | The party who plays the role |
arcaParty.PartyRoleInsertinterfaceno test imports itinterface PartyRoleInsertWhat an insert into party_role takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyRoleId | string | |
partyRoleKindCode | string | |
validFrom | string | |
validTo? | string | null | |
partyId | string |
arcaParty.PartyRoleKeytypeno test imports ittype PartyRoleKey = { readonly partyRoleId: string };The key of a row of party_role.
arcaParty.partyRoleconstno test imports itconst 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 itinterface PartyRelationRowA relation between two parties for a time, read from the first to the second: Ada is employed by Analytical Engines
| Member | Type | What it is |
|---|---|---|
partyRelationId | string | What identifies the relation |
partyRelationKindCode | string | The way the first party is related to the second |
validFrom | string | The first day the relation held |
validTo | string | null | The last day the relation held; empty while it still does |
fromPartyId | string | The party the relation is read from |
toPartyId | string | The party the relation is read to |
arcaParty.PartyRelationInsertinterfaceno test imports itinterface PartyRelationInsertWhat an insert into party_relation takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyRelationId | string | |
partyRelationKindCode | string | |
validFrom | string | |
validTo? | string | null | |
fromPartyId | string | |
toPartyId | string |
arcaParty.PartyRelationKeytypeno test imports ittype PartyRelationKey = { readonly partyRelationId: string };The key of a row of party_relation.
arcaParty.partyRelationconstno test imports itconst 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 itinterface PartyIdentifierRowAn identifier a party holds, as someone else issued it: a tax number, a passport number; a party holds one of a kind once
| Member | Type | What it is |
|---|---|---|
partyIdentifierId | string | What identifies the identifier as Arca keeps it |
partyIdentifierKindCode | string | The kind of identifier |
identifier | string | The identifier itself, as it was issued |
issuedBy | string | null | Who issued the identifier |
partyId | string | The party who holds the identifier |
arcaParty.PartyIdentifierInsertinterfaceno test imports itinterface PartyIdentifierInsertWhat an insert into party_identifier takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
partyIdentifierId | string | |
partyIdentifierKindCode | string | |
identifier | string | |
issuedBy? | string | null | |
partyId | string |
arcaParty.PartyIdentifierKeytypeno test imports ittype PartyIdentifierKey = { readonly partyIdentifierId: string };The key of a row of party_identifier.
arcaParty.partyIdentifierconstno test imports itconst 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 itinterface ElectronicContactRowA way to reach a party over a network: an email address, a telephone number, a web address
| Member | Type | What it is |
|---|---|---|
electronicContactId | string | What identifies the contact point |
medium | "email" | "telephone" | "web" | Whether this is an email address, a telephone number or a web address |
address | string | The address or number itself |
isPrimary | boolean | Whether this is the first way to try for its medium |
partyId | string | The party reached this way |
arcaParty.ElectronicContactInsertinterfaceno test imports itinterface ElectronicContactInsertWhat an insert into electronic_contact takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
electronicContactId | string | |
medium | "email" | "telephone" | "web" | |
address | string | |
isPrimary? | boolean | |
partyId | string |
arcaParty.ElectronicContactKeytypeno test imports ittype ElectronicContactKey = { readonly electronicContactId: string };The key of a row of electronic_contact.
arcaParty.electronicContactconstno test imports itconst 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 itinterface PostalAddressRowA place a party receives post or may be visited
| Member | Type | What it is |
|---|---|---|
postalAddressId | string | What identifies the address |
purpose | "billing" | "delivery" | "home" | "work" | What the address is used for: where the party lives, is billed or receives deliveries |
line1 | string | The first line: usually the building and the street |
line2 | string | null | The second line, where there is one |
locality | string | The town or city |
region | string | null | The state, province or county, where the country uses one |
postalCode | string | null | The postal code, where the country uses one |
countryCode | string | The country, as its two-letter ISO 3166-1 code |
partyId | string | The party found at the address |
arcaParty.PostalAddressInsertinterfaceno test imports itinterface PostalAddressInsertWhat an insert into postal_address takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
postalAddressId | string | |
purpose | "billing" | "delivery" | "home" | "work" | |
line1 | string | |
line2? | string | null | |
locality | string | |
region? | string | null | |
postalCode? | string | null | |
countryCode | string | |
partyId | string |
arcaParty.PostalAddressKeytypeno test imports ittype PostalAddressKey = { readonly postalAddressId: string };The key of a row of postal_address.
arcaParty.postalAddressconstno test imports itconst postalAddress: Table<PostalAddressRow, PostalAddressInsert, "postalAddress">A place a party receives post or may be visited