Documentation / @facturometro/core / Address
Interface: Address ​
Defined in: packages/core/src/model/common.types.generated.ts:654
BG-5 SELLER POSTAL ADDRESS; BG-8 BUYER POSTAL ADDRESS; BG-12 SELLER TAX REPRESENTATIVE POSTAL ADDRESS; BG-15 DELIVER TO ADDRESS.
A group of business terms providing information about the address of the Seller. Sufficient components of the address are to be filled to comply with legal requirements.
Rules ​
BR-08, BR-10, BR-19
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/
Properties ​
additionalStreetName? ​
optionaladditionalStreetName?:string
Defined in: packages/core/src/model/common.types.generated.ts:690
BT-36 Seller address line 2; BT-51 Buyer address line 2; BT-65 Tax representative address line 2; BT-76 Deliver to address line 2.
An additional address line in an address that can be used to give further details supplementing the main line.
Cardinality ​
0..1
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-AdditionalStreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-AdditionalStreetName/
addressLine? ​
optionaladdressLine?:AddressLine
Defined in: packages/core/src/model/common.types.generated.ts:756
ADDRESS LINE.
Cardinality ​
0..1
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cac-AddressLine/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cac-AddressLine/
cityName? ​
optionalcityName?:string
Defined in: packages/core/src/model/common.types.generated.ts:707
BT-37 Seller city; BT-52 Buyer city; BT-66 Tax representative city; BT-77 Deliver to city.
The common name of the city, town or village, where the Seller address is located.
Cardinality ​
0..1
Rules ​
IT-R-003
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-CityName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-CityName/
country ​
country:
Country
Defined in: packages/core/src/model/common.types.generated.ts:770
COUNTRY.
Cardinality ​
1..1
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cac-Country/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cac-Country/
countrySubentity? ​
optionalcountrySubentity?:string
Defined in: packages/core/src/model/common.types.generated.ts:742
BT-39 Seller country subdivision; BT-54 Buyer country subdivision; BT-68 Tax representative country subdivision; BT-79 Deliver to country subdivision.
The subdivision of a country.
Cardinality ​
0..1
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-CountrySubentity/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-CountrySubentity/
postalZone? ​
optionalpostalZone?:string
Defined in: packages/core/src/model/common.types.generated.ts:725
BT-38 Seller post code; BT-53 Buyer post code; BT-67 Tax representative post code; BT-78 Deliver to post code.
The identifier for an addressable group of properties according to the relevant postal service.
Cardinality ​
0..1
Rules ​
IT-R-004
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-PostalZone/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-PostalZone/
streetName? ​
optionalstreetName?:string
Defined in: packages/core/src/model/common.types.generated.ts:672
BT-35 Seller address line 1; BT-50 Buyer address line 1; BT-64 Tax representative address line 1; BT-75 Deliver to address line 1.
The main address line in an address.
Cardinality ​
0..1
Rules ​
IT-R-002
See ​
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/cac-Party/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/cac-Party/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/cac-PostalAddress/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-StreetName/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/cac-DeliveryLocation/cac-Address/cbc-StreetName/