ebxml Core Components Structure v1.04

Transcription

1 ebxml s Structure v1.04 Data ) SECTION 1: Types date time. n/a n/a n/a n/a CCT A particular point in the progression of time together with relevant supplementary information date time. content n/a string n/a Basic R The particular point in the progression of time. Can be for a date and/or time date time. format. text n/a string n/a Basic The format of the date/time content. Reference ISO 8601 Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 1 of 28

2 Data ) n/a n/a n/a n/a CCT A character string (letters, figures or symbols) that for brevity and/or language independence may be to represent or replace a definitive value or text of an attribute together with relevant supplementary information content list. n/a string n/a Basic A character string (letters, figures or symbols) that for brevity and/or language independence may be to represent or replace a definitive value or text of an attribute. n/a string n/a Basic The name of a list of s. Can be to identify the URL of a source that defines the set of currently approved permitted values. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 2 of 28

3 Data ) list. agency list. version. n/a string n/a Basic An agency that maintains one or more lists. n/a string n/a Basic The version of the list name n/a string n/a Basic The textual equivalent of the content language. n/a string n/a Basic The of the language in the corresponding text string. If no content exists, the name can be on its own. Reference ISO 639: 1998 Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 3 of 28

4 Data ) text. n/a n/a n/a n/a CCT A character string with or without a specified language text. content n/a string n/a Basic R A character string generally in the form of words language. n/a string n/a Basic The of the language in the corresponding text string. Reference ISO 639: 1998 Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 4 of 28

5 Data ) content identification scheme. name n/a n/a n/a n/a CCT A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects within the same scheme together with relevant supplementary information. n/a string n/a Basic R A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects within the same scheme. n/a string n/a Basic The name of the identification scheme. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 5 of 28

6 Data ) identification scheme agency. name language. n/a string n/a Basic The agency that maintains the identification scheme. n/a string n/a Basic The of the language in the corresponding text string. Reference ISO 639: 1998 Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 6 of 28

7 Data ) amount. n/a n/a n/a n/a CCT A number of monetary units specified in a currency where the unit of currency is explicit or implied amount n/a decimal n/a Basic R A number of monetary units specified in a currency where the unit of currency is explicit or implied amount currency. identification. n/a string currency. identification. (000133) Basic The currency of the amount. Reference ISO Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 7 of 28

8 Data ) quantity. n/a n/a n/a n/a CCT A number of nonmonetary units together with relevant supplementary information quantity n/a decimal n/a Basic R A number of nonmonetary units quantity. unit. n/a string n/a Basic R The unit of the quantity. May use UN/ECE Recommendation #20 and X12 355, but for actual measurements use the CCT measure. For example, for $10/100 km use CCT quantity and for a measured distance of 20 kilometers use CCT measure quantity unit list quantity unit list agency. n/a string n/a Basic The quantity unit list. n/a string n/a Basic The agency which maintains the quantity unit list. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 8 of 28

9 Data ) measure measure. content measure unit. n/a n/a n/a n/a CCT The size, volume, mass, amount or scope derived by performing a physical measure together with relevant supplementary information. n/a decimal n/a Basic The size, volume, mass, amount or scope derived by performing a physical measure. n/a string n/a Basic The of unit of measure. For example, 20 kilograms (20 is the measure content) Reference UN/ECE Recommendation #20 and X For example, for $10/100 km use CCT quantity and for a measured distance of 20 kilometers use CCT measure. SECTION 2: Entities party. n/a n/a n/a n/a Details of an individual, a group or a body having a role in a business function. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 9 of 28

10 Data ) party.. n/a n/a Basic A character string to uniquely identify and distinguish a party party. description. text text. n/a n/a Basic Text providing information on the party. This text may cover information which is in addition to the structured information but cannot be provided within the given structure party person organisation.. n/a n/a Basic The characteristics of a party which is independent of its role. n/a n/a n/a A human being regarded as an individual. n/a n/a n/a An organised body such as a business, government body, department, charity, etc. this can be to distinguish legal entities from individual persons or a group of people person. n/a n/a n/a n/a A human being regarded as an individual. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 10 of 28

11 Data ) person. name person. tax birth. date date time person. given. name person. middle. name person. surname. name person. gender person. nationality person. name prefix. text. n/a n/a Basic The full name of a person.. n/a n/a Basic The registered national tax identification of a person. n/a n/a Basic The date on which a person was born. text. n/a n/a Basic The given name, first name, Christian name or moniker of a person. text. n/a n/a Basic The middle name(s) or initial(s) of a person. text. n/a n/a Basic The surname, last name or family name of a person.. n/a n/a Basic The gender of a person.. n/a n/a Basic The identification of a nation that a person belongs to.. n/a n/a Basic A title that prefixes a persons name. Expressed in a single string. Applies only to parties being natural persons. Applies only to parties being natural persons. This applies only to parties being natural persons This applies only to parties being natural persons This applies only to parties being natural persons This applies only to parties being natural persons For example Mr, Mrs, Dr, or Sir. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 11 of 28

12 Data ) person. name suffix.. n/a n/a Basic A title that follows a persons name. For example 3rd, junior, BSc, or Esq organisation. n/a n/a n/a n/a An organised body such as a business, government body, department, charity, etc organisation. name organisation registration. country. text. n/a n/a Basic The text to identify an organisation, the organisation's name.. n/a n/a Basic The country in which an organisation is registered organisation registration. date date time. n/a n/a Basic The date on which an organisation was first registered with a governing body organisation. tax.. n/a n/a Basic The registered national tax identification of a organisation. For example VAT Number or company registration number. Does not apply to parties being natural persons. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 12 of 28

13 Data ) postal address. n/a n/a n/a n/a The collection of information which locates and identifies a specific address as defined by postal services The address will be limited depending on the context in which it is address... n/a n/a Basic The of the address. For example a business address or a home address. Not the Role of the address street building.. n/a n/a Basic A number that identifies the position of a building on a street street. name. text district. name. text town. name. text text. n/a n/a Basic The name of a street or thoroughfare. text. n/a n/a Basic A part of a town or region. text. n/a n/a Basic A built up area with a name, defined boundaries and a local government. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 13 of 28

14 Data ) state.. n/a n/a Basic An organised political community or area forming a part of a federation post country post office box building building. name. n/a n/a Basic A group of letters and/or numbers which are added to a postal address to assist the sorting of mail.. n/a n/a Basic A nation with its own government. n/a n/a Basic A numbered box in a post office assigned to a person or organisation where letters for them are kept until called for. Reference ISO n/a string n/a Basic The identification of a building within For example a building name or number on a a group of buildings campus or within a that have the same company. street number. text. n/a n/a Basic The name of the building or house. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 14 of 28

15 Data ) suite mail delivery. sublocation floor. n/a string n/a Basic The identification of a suite or apartment lot block district subdivision region county. n/a n/a Basic A specific place to deliver mail within a predefined postal address. n/a string n/a Basic A floor or storey within a building. n/a n/a Basic An identification of an allotment of land. n/a string n/a Basic A group of buildings bounded by (usually four) streets.... n/a n/a Basic A sub-division of a district. n/a n/a Basic An administrative division of a country, state or territory. n/a n/a Basic A territorial division of some countries, forming the chief unit of local administration. May be provided in the form of a name. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 15 of 28

16 Data ) postal address. line 1. text postal address. line 2. text postal address. line 3. text postal address. line 4. text postal address. line 5. text text. n/a n/a Basic The first free format line of a postal address. text. n/a n/a Basic The second free format line of a postal address. text. n/a n/a Basic The third free format line of a postal address. text. n/a n/a Basic The fourth free format line of a postal address. text. n/a n/a Basic The fifth free format line of a postal address communicatio n number. n/a n/a n/a n/a The information for one communication number or virtual address communicati on communicati on. mode.. n/a n/a Basic The of communication.. n/a n/a Basic R The way or manner in which the communication is made. For example home or business. For example fax, phone, , http, https,... Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 16 of 28

17 Data ) communicati on telephone country telephone area telephone subscriber telephone extension n/a n/a Basic The number or virtual address of communication. n/a n/a Basic The telephone for a country. n/a n/a Basic The telephone for a geographical area within a country. n/a n/a Basic The telephone for a subscriber within a geographical area. n/a n/a Basic A subsidiary telephone with it's own additional number as an extension of a subscriber. Can be to identify a phone number as a single string. Reference International Telecommunications Union (ITU) E location location. identification. n/a n/a n/a n/a A particular geographical place or position.. n/a n/a Basic R The of a location. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 17 of 28

18 Data ) location location. description. text. n/a n/a Basic An identification of the of location text. n/a n/a Basic A free text description of the location For example an airport or train station financial account. n/a n/a n/a n/a A service through a Not a general ledger. bank or other organisation through which funds are held on behalf of a client or goods or services are supplied on credit financial account financial account. name financial account. country.. n/a n/a Basic R The of the account. text. n/a n/a Basic Full name of an account.. n/a n/a Basic The country in which the account is held. Which usually identifies the ownership of the account Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 18 of 28

19 Data ) financial account currency. identification.. n/a n/a Basic The currency of the account financial account product financial account nickname. name transport. means transport means. identification transport means. name transport means. nationality.. n/a n/a Basic The of account product. text. n/a n/a Basic Familiar name given to an account as well as the account name. n/a n/a n/a n/a Vehicle for the conveyance of goods or persons. n/a n/a Basic Identification of a means of transport. text. n/a n/a Basic The name of the means of transport.. n/a n/a Basic The nationality of the means of transport. For example a Savings Plus. For example information about a truck or tanker. For example the vessel call sign or vehicle registration. For example the vessel name. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 19 of 28

20 Data ) packaging packaging.. n/a n/a n/a n/a related to an object or group of objects wrapped or packed. n/a n/a Basic Identification of the packaging For example box, barrel or bottle. Reference UN/ECE Recommendation # packaging. quantity quantity. n/a n/a Basic Number of objects or groups of objects packaging. level packaging. material.. n/a n/a Basic Positional location of an object or groups of objects. n/a n/a Basic Identification of the packaging material For example, inner, outer For example, wood, paper, plastic product service. n/a n/a n/a n/a A thing or substance produced by natural process or manufacturer and or a provision or system of supplying a need. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 20 of 28

21 Data ) product service product service product service. description. text product service start. dateandtime. n/a n/a Basic A character string to uniquely identify and distinguish a product/service.. n/a n/a Basic An identification of the of product/service. text. n/a n/a Basic A textual description of the product/service. date time. n/a n/a Basic A date and/or time on which a product/service starts. UN/ECE UNSPC list product date time. service end. dateandtime product service classificatio n.. n/a n/a Basic A date and/or time on which a product/service ends. n/a n/a Basic A character string to identify and distinguish uniquely, one product/service classification from another. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 21 of 28

22 Data ) currency exchange source currency. identification. n/a n/a n/a n/a Details needed or to make an exchange of an amount from one currency to another.. n/a currency. identification. (000133) Basic Code identifying the currency from which the exchange is being made target currency. identification base currency. identification.. n/a currency. identification. (000133). n/a currency. identification. (000133) Basic Basic Code identifying the currency to which the exchange is being made. The currency that is on the 'one unit' side of the rate of exchange. The base currency amount divided by the currency exchange rate gives the second currency amount currency. exchange. rate n/a number n/a Basic The rate at which the currency exchange is calculated. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 22 of 28

23 Data ) source currency. scale. value target currency. scale. value exchange. date time. rate. dateandtime n/a number scale. value (000134) n/a number scale. value (000134) Basic Basic n/a n/a Basic The date and time of the exchange rate. The base of the Used when the source currency source currency is on expressed as 1, 10, the 'one unit' side of a 100 or 1000 rate of exchange. depending on the scale for the monetary unit. The base of the Used when the target target currency currency is on the 'one expressed as 1, 10, unit' side of a rate of 100 or 1000 exchange. depending on the scale for the monetary unit charge price charge price. amount n/a n/a n/a n/a about the amount of money expected, required, or given in payment for something. amount. n/a n/a Basic The amount of money expected, required, or given in payment for something. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 23 of 28

24 Data ) charge price. description. text text. n/a n/a Basic Text providing information on the charge/price. This text may cover information which is in addition to the structured information but cannot be provided within the given structure charge price. tax inclusion. indicator percentage charge price unit charge price. n/a n/a n/a Basic An indicator specifying if the charge/price includes tax. n/a n/a n/a A financial liability calculated using a percentage charge. n/a n/a n/a A financial liability calculated using a per unit charge or price for a quantity. For example US dollars per day percentage charge price. n/a n/a n/a n/a A financial liability calculated using a percentage charge. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 24 of 28

25 Data ) charge price. percentage chargeable. amount n/a decimal n/a Basic The percentage applied to the chargeable amount to find the charge/price amount. amount. n/a n/a Basic The amount on which the charge is made unit charge price. n/a n/a n/a n/a A financial liability calculated using a per unit charge or price for a quantity. For example US dollars per day unit charge price. amount base charge price. quantity amount. n/a n/a Basic The charge/price amount per unit. quantity. n/a n/a Basic The base quantity of the charge/price unit amount. For example, for a charge of $5/day for 10 days, the charge unit amount is $5. For example, for a charge of $5/day for 10 days, the charge base quantity is 1 day chargeable. quantity quantity. n/a n/a Basic The quantity on which the charge or price is made. For example, for a charge of $5/day for 10 days, the chargeable quantity is 10 days. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 25 of 28

26 Data ) tax. n/a n/a n/a n/a A compulsory contribution to governmental revenue, levied on personal income and business profits or added to the cost of some goods, services, and transactions tax. amount amount. n/a n/a Basic The amount of tax tax. description. text text. n/a n/a Basic Text providing information on the tax. This text may cover information which is in addition to the structured information but cannot be provided within the given structure tax. category tax. percentage. n/a n/a Basic The tax category which relates an item to the rate of tax charged. n/a number n/a Basic The percentage applied to the taxable amount to find the tax amount. For example standard, exempt, or zero rated. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 26 of 28

27 Data ) taxable. amount Examples of Re-use of s amount. n/a n/a Basic The amount on which tax at this rate is calculated. Allows for one price charge to have different rates of tax applied to it account servicer party account owner party contact party. n/a n/a n/a party. (000001) n/a n/a n/a party. (000001) n/a n/a n/a party. (000001) about the organisation at which an account is held. The entity which is the owner of the account. The contact person or department for an organisation charge financial account n/a n/a n/a financial account. (000010) The financial account to be charged. Additional Basic Entities The additional Basic Entities below have been identified payment card. expiration. date date time. n/a n/a Basic The expiration date of a payment card that is associated with an account. Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 27 of 28

28 Data ) transport method.. n/a n/a Basic Method of transport for the conveyance of goods or persons currency. n/a string n/a Basic The currency of identification money scale. value n/a number n/a Basic The base rate of a number expressed as 1, 10, 100, 1000 (or higher multiples of 10) line transport stage exchange contract. reference. n/a string n/a Basic The line number of a document, record or file.. n/a n/a Basic Identification of a stage of transport. A stage in a journey. n/a string n/a Basic A reference or pointer to a document defining the conditions and rates under which an exchange of currencies occurs. For example, by air, by rail, by sea. Uses values from ISO For example the line number of an invoice. For example, precarriage, main carriage, on-carriage Structure Copyright UN/CEFACT and OASIS, All Rights Reserved. Page 28 of 28