Changes for page Invoice Service

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,1 +1,155 @@
1		-Test
	1	+= Introduction =
	2	+
	3	+PayEx CUSIN is a file format for customers to send customer and invoice information to PayEx.
	4	+
	5	+= What you need before you get started =
	6	+
	7	+* sFTP Client
	8	+* Agreement that includes PayEx CUSIN
	9	+* Obtained credentials from PayEx
	10	+* Basic understanding of file name convention and file format limitations
	11	+
	12	+To get a grasp of what we expect of your implementation when you are finished, we recommend that you take a peek at the following diagram before you get started.
	13	+
	14	+> insert fancy diagram here
	15	+
	16	+= What you should do, step by step =
	17	+
	18	+Below is an example provided in .XML
	19	+
	20	+Note that the example is for a basic usage of the file format. It is provided to help understanding the file format and give the implementation a head start. For more extensive usage of the file format, head over to the [[API reference>>Reference]].
	21	+
	22	+If you encounter any problem with the implementation, please visit the troubleshooting section.
	23	+
	24	+== Step 1 Create file and add XML declaration ==
	25	+
	26	+{{tabs idsToLabels="Step1_Description=Description, Step1_Example=Example"/}}
	27	+
	28	+(% id="Step1_Description" %)
	29	+(((
	30	+Create a file with extension .XML and UTF-8 encoding. Name it according to the filename convention.
	31	+\\Add a row on root level with XML declaration, with XML-version 1.0 and UTF-8 encoding.
	32	+\\You can read more about this [[here>>File Reference]].
	33	+)))
	34	+
	35	+(% id="Step1_Example" %)
	36	+(((
	37	+Filename: ##CUSIN_<CompanyNumber>_<DateTime>_<SerialNumber>.XML##
	38	+\\{{code language="xml"}} <︖xml version="1.0" encoding="utf-8"︖> (xwiki eats the declaration while using default question mark){{/code}}
	39	+)))
	40	+
	41	+== Step 2 Add CUSIN Header ==
	42	+
	43	+
	44	+
	45	+{{tabs idsToLabels="Step2_Description=Description, Step2_Example=Example"/}}
	46	+
	47	+(% id="Step2_Description" %)
	48	+(((
	49	+Add a CUSIN Header at root level with the following attributes.
	50	+
	51	+* XSD version
	52	+* Createion date and time
	53	+* Company number
	54	+* Company name
	55	+
	56	+You can read more about this [[here>>Reference]].
	57	+)))
	58	+
	59	+(% id="Step2_Example" %)
	60	+(((
	61	+{{code language="xml"}}
	62	+ <︖xml version="1.0" encoding="utf-8"︖>
	63	+ <CUSIN Version="2.0" CreatedDateTime="2017-12-07T14:54:55" CompanyName="Test Company" CompanyNo="9999">
	64	+ </CUSIN>
	65	+{{/code}}
	66	+)))
	67	+
	68	+== Step 3 Distribution Date ==
	69	+
	70	+
	71	+
	72	+{{tabs idsToLabels="Step3_Description=Description, Step3_Example=Example"/}}
	73	+
	74	+(% id="Step3_Description" %)
	75	+(((
	76	+Set your distribution date.
	77	+\\Add a child element {{code}}DistributionDate{{/code}}. This can be set to a date (in the future) of your choosing or you can leave it up to us.
	78	+\\In this example we have set the value to{{code}}AsSoonAsPossible{{/code}}.
	79	+\\You can read more about this [[here>>Reference]].
	80	+)))
	81	+
	82	+(% id="Step3_Example" %)
	83	+(((
	84	+{{code language="xml"}}
	85	+<︖xml version="1.0" encoding="utf-8"︖>
	86	+<CUSIN Version="2.0" CreatedDateTime="2017-12-07T14:54:55" CompanyName="Test Company" CompanyNo="9999">
	87	+ <DistributionDate>
	88	+ <AsSoonAsPossible />
	89	+ </DistributionDate>
	90	+</CUSIN>
	91	+{{/code}}
	92	+)))
	93	+
	94	+== Step 4 CUSINInfo ==
	95	+
	96	+Define CUSINInfo per customer.
	97	+
	98	+{{tabs idsToLabels="Step4_Description=Description, Step4_Example=Example"/}}
	99	+
	100	+(% id="Step4_Description" %)
	101	+(((
	102	+In order to define the CUSINInfo per customer you need to do add the following child elements:
	103	+Add {{code}}CustomerNo{{/code}}, {{code}}CustomerInfo{{/code}} and {{code}}Invoices{{/code}} to the {{code}}CUSINInfo{{/code}} parent.
	104	+\\You can read more about this [[here>>File Reference]].
	105	+\\We will go into more details related to {{code}}CustomerInfo{{/code}} element and {{code}}Invoices{{/code}} element in the coming steps.
	106	+
	107	+)))
	108	+
	109	+(% id="Step4_Example" %)
	110	+(((
	111	+{{code language="xml"}}
	112	+<︖xml version="1.0" encoding="utf-8"︖>
	113	+<CUSIN Version="2.0" CreatedDateTime="2017-12-07T14:54:55" CompanyName="Test Company" CompanyNo="9999">
	114	+ <DistributionDate>
	115	+ <AsSoonAsPossible />
	116	+ </DistributionDate>
	117	+ <CUSINInfo>
	118	+ <CustomerNo>1</CustomerNo>
	119	+ <CustomerInfo/>
	120	+ <Invoices/>
	121	+ </CUSINInfo>
	122	+</CUSIN>
	123	+{{/code}}
	124	+)))
	125	+
	126	+>NOT DONE STUFF!!
	127	+
	128	+== Step 5 Customer info ==
	129	+
	130	+== Step 6 Invoices ==
	131	+
	132	+**Validation**
	133	+
	134	+The XML-file must be validated with the lastest XML Schema Definition (XSD).
	135	+This is found here (provide link).
	136	+
	137	+**Transfer the file**
	138	+
	139	+== Step 7 FTP the file ==
	140	+
	141	+== Step X: Template ==
	142	+
	143	+Lorem Ipsum
	144	+
	145	+{{tabs idsToLabels="TextA=Panel A, TextB=PanelB"/}}
	146	+
	147	+(% id="TextA" %)
	148	+(((
	149	+Text A
	150	+)))
	151	+
	152	+(% id="TextB" %)
	153	+(((
	154	+Text B
	155	+)))