Postbeskrivning Customerjournal_1.0 innehåll

Transkript

1 Postbeskrivning Customerjournal_1.0 innehåll 1 Versionshistorik Relaterade dokument Allmänt Filnamnbeskrivning Validering Övergripande bild XML-struktur XML-struktur Customerjournal CustomerJournal/CustomerJournalInfo CustomerJournal/CustomerJournalInfo/CustomerInfo CustomerJournal/CustomerJournalInfo/ConsentEventInfo CustomerJournal/CustomerJournalInfo/CustomerStatusEventInfo

2 1 Versionshistorik Version Datum Beskrivning Gjord av Godkänd av Dokumentet skapat JKR 2 Relaterade dokument Dokument CustomerJournal_[1.0].XSD Beskrivning Schemafil för Customer journal 3 Allmänt Customerjournal är det filformat som används för att kommunicera förändringar på kunderna i reskontran som härrör från den/de tjänster som avtalats. Exempel på händelser som kan kommuniceras beroende på avtalad tjänst är: Att ny legal adress har hittats i de fall reskontran har avtal om adressökning Aktivering/deaktivering av Svenskt autogiromedgivande Aktivering/deaktivering av Svensk B2C EFaktura Att slutkundkund registrerats som avliden 3.1 Filnamnbeskrivning Filnamn: CUSTOMERJOURNAL_<Firmanr>_<DatumTid>_<Löpnr>.xml. <DatumTid> (YYYYMMDDHHMMSS) och är datum och tid då filen skapades. <Löpnr> är en obruten nummerserie där firmans första fil skall ha 1 nästa 2 osv. Exempel: CUSTOMERJOURNAL_9999_ _1.xml 3.2 Validering Customerjournal-filen ska svara mot aktuell version av CustomerJournal_[X.X].xsd. 2

3 4 Övergripande bild XML-struktur 3

4 5 XML-struktur Customerjournal element CustomerJournal children CustomerJournalInfo attributes Name Type Use Default Fixed Annotation Version xs:string required 1.0 The version of the schema-file (XSD) to be used for validation of the xml-file CreatedDateTime xs:datetime required The date and time when the file was created CompanyNo CompanyNumber required Your accounts receivable number at PayEx CompanyName xs:string required The name of your company/accounts recievable at PayEx attribute type xs:string use required fixed 1.0 The version of the schema-file (XSD) to be used for validation of the xml-file attribute type xs:datetime use required The date and time when the file was created attribute type CompanyNumber use required maxlength 15 [0-9]* Your accounts receivable number at PayEx 4

5 attribute type xs:string use required The name of your company/accounts recievable at PayEx 5.1 CustomerJournal/CustomerJournalInfo element CustomerJournal/CustomerJournalInfo minocc 1 maxocc unbounded children CustomerNo RegNo CustomerInfo ConsentEventInfo CustomerStatusEventInfo element CustomerJournal/CustomerJournalInfo/CustomerNo type Identifier15 maxlength 15 [a-za-z0-9äåöäåö&/_ -.]* CustomerNo is your unique identifier of the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/RegNo type RegNo minocc 0 attributes maxlength 15 Name Type Use Default Fixed Annotation CountryCode ISO3166 required If exists, Customer social security number/corporate identity number in the accounts receivable 5

6 5.1.1 CustomerJournal/CustomerJournalInfo/CustomerInfo element CustomerJournal/CustomerJournalInfo/CustomerInfo minocc 0 children Name Category LanguageCode VatNo DistributionAddressInfo attributes Name Type Use LegalEntity LegalEntity optional Default Fixed Annotation If exists the current legal entity of the customer in the accounts receivable. attribute CustomerJournal/CustomerJournalInfo/CustomerInfo/@LegalEntity type LegalEntity use optional Private Business If exists the current legal entity of the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerInfo/Name type NameAddressString72 maxlength 72 [a-za-z0-9_:!;"#<>=?\[\]@{} %-/À-ÖØ-öø-úü]* The current full name of the customer in the accounts receivable. element CustomerJournal/CustomerJournalInfo/CustomerInfo/Category type String10 minocc 0 maxlength 10 If exists, the current category the customer is a member of in the accounts receivable 6

7 element CustomerJournal/CustomerJournalInfo/CustomerInfo/LanguageCode type ISO639 minocc 0 SV NO DA FI EN If exists, the current differing language code according to iso 639 set for the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerInfo/VatNo type VatNumber minocc 0 minlength 7 maxlength 14 [A-Z]{2}.* If exists, the current VAT registration number of the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo children Addresses Address Cellphone Containing the current distribution address information of the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/Addresses children Address Contains the current addresses of the customer in the accounts receivable 7

8 element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/Addresses/Address type Address minocc 1 maxocc 2 children Addressee StreetAddress ZipCode City CoAddress CountryCode attributes Name Type Use AddressType AddressType required Default Fixed Annotation Type of address element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/ Address type minocc 0 maxlength 60 If exists, the current of the customer in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/Cellphone type String15 minocc 0 maxlength 15 If exists, the current mobile number of the customer in the accounts receivable CustomerJournal/CustomerJournalInfo/ConsentEventInfo element CustomerJournal/CustomerJournalInfo/ConsentEventInfo minocc 0 children ConsentEvent Containing changes/events concerning customer consents in the accounts receivable 8

9 element CustomerJournal/CustomerJournalInfo/ConsentEventInfo/ConsentEvent type ConsentEvent minocc 0 maxocc unbounded children ConsentType ConsentEventDate Status Contains information about a consent event CustomerJournal/CustomerJournalInfo/CustomerStatusEventInfo element CustomerJournal/CustomerJournalInfo/CustomerStatusEventInfo minocc 0 children CustomerStatusEvent Containing changes/events concerning customer status in the accounts receivable element CustomerJournal/CustomerJournalInfo/CustomerStatusEventInfo/CustomerStatusEvent type CustomerStatusEvent minocc 0 maxocc unbounded children CustomerStatusType CustomerStatusEventDate Status Contains information about a change of the customer status in the accounts receivable complextype Address children Addressee StreetAddress ZipCode City CoAddress CountryCode attributes element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/Addresses/Address Name Type Use AddressType AddressType required Default Fixed Annotation Type of address attribute Address/@AddressType type AddressType use required LegalAddress Referes to the customers legal address BillingAddress Referes to a possible billing address Type of address 9

10 element Address/Addressee type NameAddressString72 maxlength 72 %-/À-ÖØ-öø-úü]* Current full name of addressee element Address/StreetAddress type NameAddressString35 minocc 0 maxlength 35 Current street address [a-za-z0-9_:!;"#<>=?\[\]@{} %-/À-ÖØ-öø-úü]* element Address/ZipCode type ZipCode maxlength 9 Current zip code [A-Z0-9\-]+ element Address/City type NameAddressString27 maxlength 27 Current city [a-za-z0-9_:!;"#<>=?\[\]@{} %-/À-ÖØ-öø-úü]* 10

11 element Address/CoAddress type NameAddressString35 minocc 0 maxlength 35 [a-za-z0-9_:!;"#<>=?\[\]@{} %-/À-ÖØ-öø-úü]* If exists current care of address element Address/CountryCode type ISO3166 minlength 2 maxlength 2 [A-Z]* Current countrycode complextype ConsentEvent children ConsentType ConsentEventDate Status element CustomerJournal/CustomerJournalInfo/ConsentEventInfo/ConsentEvent element ConsentEvent/ConsentType type ConsentType BGAGSE Refers to a Swedish direct debit consent. EInvoiceB2CSE Referes to a Swedish B2C E-invoice consent. The type of consent affected by the event/change element ConsentEvent/ConsentEventDate type xs:date The date when the event occurred 11

12 element ConsentEvent/Status type ConsentStatus Active The consent has been activated Cancelled The consent has been deactivated/cancelled The state of the consent due to the event complextype CustomerStatusEvent children CustomerStatusType CustomerStatusEventDate Status element CustomerJournal/CustomerJournalInfo/CustomerStatusEventInfo/CustomerStatusEvent element CustomerStatusEvent/CustomerStatusType type CustomerStatusType Deceased A status type that can be set on consumers The type of status that has been affected by the event/change element CustomerStatusEvent/CustomerStatusEventDate type xs:date The date when the event occurred element CustomerStatusEvent/Status type CustomerStatus Active The status has been activated on the customer. Cancelled The status has been deactivted on the customer. The state of the customer status due to the event 12

13 complextype RegNo type extension of String15 attributes base String15 element CustomerJournal/CustomerJournalInfo/RegNo maxlength 15 Name Type Use Default Fixed Annotation CountryCode ISO3166 required attribute type ISO3166 use required minlength 2 maxlength 2 [A-Z]* simpletype AddressType attribute Address/@AddressType LegalAddress Referes to the customers legal address BillingAddress Referes to a possible billing address simpletype CompanyNumber attribute CustomerJournal/@CompanyNo maxlength 15 [0-9]* 13

14 simpletype ConsentStatus element ConsentEvent/Status Active The consent has been activated Cancelled The consent has been deactivated/cancelled simpletype ConsentType element ConsentEvent/ConsentType BGAGSE Refers to a Swedish direct debit consent. EInvoiceB2CSE Referes to a Swedish B2C E-invoice consent. simpletype CustomerStatus element CustomerStatusEvent/Status Active The status has been activated on the customer. Cancelled The status has been deactivted on the customer. simpletype CustomerStatusType element CustomerStatusEvent/CustomerStatusType Deceased A status type that can be set on consumers 14

15 simpletype type restriction of PXString base PXString element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/ Address maxlength 60 simpletype Identifier15 element CustomerJournal/CustomerJournalInfo/CustomerNo maxlength 15 [a-za-z0-9äåöäåö&/_ -.]* simpletype ISO3166 element Address/CountryCode attribute minlength 2 maxlength 2 [A-Z]* simpletype ISO639 type restriction of PXString base PXString element CustomerJournal/CustomerJournalInfo/CustomerInfo/LanguageCode SV NO DA FI EN 15

16 simpletype LegalEntity attribute Private Business simpletype NameAddressString27 type restriction of PXNameAddressString base PXNameAddressString element Address/City maxlength 27 %-/À-ÖØ-öø-úü]* simpletype NameAddressString35 type restriction of PXNameAddressString base PXNameAddressString elements Address/CoAddress Address/StreetAddress maxlength 35 %-/À-ÖØ-öø-úü]* simpletype NameAddressString72 type restriction of PXNameAddressString base PXNameAddressString elements Address/Addressee CustomerJournal/CustomerJournalInfo/CustomerInfo/Name maxlength 72 %-/À-ÖØ-öø-úü]* 16

17 simpletype PXNameAddressString simpletypes NameAddressString27 NameAddressString35 NameAddressString72 %-/À-ÖØ-öø-úü]* simpletype PXString simpletypes ISO639 String10 String15 String25 String30 String35 simpletype String10 type restriction of PXString base PXString element CustomerJournal/CustomerJournalInfo/CustomerInfo/Category maxlength 10 simpletype String15 type restriction of PXString base PXString element CustomerJournal/CustomerJournalInfo/CustomerInfo/DistributionAddressInfo/Cellphone complextype RegNo maxlength 15 17

18 simpletype String25 type restriction of PXString base PXString maxlength 25 simpletype String30 type restriction of PXString base PXString maxlength 30 simpletype String35 type restriction of PXString base PXString maxlength 35 simpletype String50 maxlength 50 simpletype VatNumber element CustomerJournal/CustomerJournalInfo/CustomerInfo/VatNo minlength 7 maxlength 14 [A-Z]{2}.* 18

19 simpletype ZipCode element Address/ZipCode maxlength 9 [A-Z0-9\-]+ 19