Wiki source code of 3. Contract billing
Last modified by Jenny Eklund on 2024/03/20 08:36
![]() |
77.1 | 1 | = = |
![]() |
1.1 | 2 | |
3 | (% class="jumbotron" %) | ||
4 | ((( | ||
5 | (% class="container" %) | ||
6 | ((( | ||
![]() |
7.1 | 7 | //This is a technical overview of the **ContractBilling **file (XML) to be sent to PayEx upon billing of customer contracts. The file contains detailed billing instructions for each customer contract that should be billed.// |
![]() |
1.1 | 8 | ))) |
9 | ))) | ||
10 | |||
11 | (% class="row" %) | ||
12 | ((( | ||
13 | (% class="col-xs-12" %) | ||
14 | ((( | ||
![]() |
7.1 | 15 | {{warning}} |
16 | Please note that your Response files might only utilize and/or contain a subset of all elements described below. See the XSD version for your response files to learn more. | ||
17 | {{/warning}} | ||
18 | |||
![]() |
1.1 | 19 | ---- |
20 | |||
![]() |
7.1 | 21 | == Overview == |
![]() |
1.1 | 22 | |
![]() |
8.1 | 23 | The Contract billing file contains all customers and contracts that is to billed. |
24 | |||
![]() |
10.1 | 25 | For each contract, the total amount to bill must be stated including a specification of all the products that is part of the bill/amount. |
![]() |
7.1 | 26 | In addition to the billing instructions, the customer's address should always be included in this file. |
27 | |||
28 | //Below diagram shows the structure of ContractBilling in current version// | ||
29 | |||
![]() |
80.1 | 30 | |
![]() |
1.1 | 31 | ))) |
32 | ))) | ||
33 | |||
34 | (% class="row" %) | ||
35 | ((( | ||
36 | (% class="col-xs-12" %) | ||
37 | ((( | ||
![]() |
82.1 | 38 | [[image:ContractBilling_[1.X].xsd.png||height="1995" width="513"]] |
![]() |
1.1 | 39 | |
40 | ---- | ||
41 | |||
![]() |
77.1 | 42 | == == |
![]() |
5.1 | 43 | |
![]() |
1.1 | 44 | == Name convention == |
![]() |
5.1 | 45 | |
46 | |||
![]() |
1.1 | 47 | ))) |
48 | ))) | ||
49 | |||
50 | ContractBilling_<CompanyNumber>_<DateTime>_<SerialNumber>.xml | ||
51 | |||
52 | (% class="table-bordered table-striped" %) | ||
53 | |=Names Component|=Description | ||
54 | |CompanyNumber|The company number in our ledger system | ||
55 | |DateTime|Date created, Should be in the format ISO 8601 format, YYYYMMDDThhmmdd | ||
56 | |SerialNumber|Should follow an uninterupted number series, 00001, and so on. | ||
57 | |||
58 | == Download current XML schema file == | ||
59 | |||
60 | (% class="row" %) | ||
61 | ((( | ||
62 | (% class="col-xs-12" %) | ||
63 | ((( | ||
64 | (% border="0" style="width:1023px" %) | ||
65 | |=(% style="width: 208px; background-color: rgb(237, 237, 237);" %)Fileversion|=(% style="width: 213px; background-color: rgb(237, 237, 237);" %)Version|=(% style="width: 288px; background-color: rgb(237, 237, 237);" %)Releasedate|=(% style="width: 585px; background-color: rgb(237, 237, 237);" %)Comment | ||
![]() |
24.1 | 66 | |(% style="width:208px" %)[[ContractBilling_[1.0].xsd>>attach:Main.Contract-financing.Technical-reference.WebHome@ContractBilling_[1.0] .xsd]]|(% style="width:213px" %)1.0|(% style="width:288px" %)(% style="left:-5000px; width:1px" %)2018-04-01|(% style="width:585px" %)(% style="left:-5000px; width:1px" %)Initial version |
![]() |
40.1 | 67 | |(% style="width:208px" %)[[ContractBilling_[1.1].xsd>>attach:Main.Contract-financing.Technical-reference.WebHome@ContractBilling_[1.1].xsd||queryString="rev=1.1"]]|(% style="width:213px" %)1.1|(% style="width:288px" %)2021-10-11|(% style="width:585px" %)Added support for RecurringCard |
![]() |
47.1 | 68 | |(% style="width:208px" %)[[ContractBilling_[1.2].xsd>>attach:ContractBilling_[1.2].xsd]]|(% style="width:213px" %)1.2|(% style="width:288px" %)2022-04-05|(% style="width:585px" %)Added support for OffContract. |
![]() |
40.1 | 69 | Added distributionType that alters the default distribution for the billing instruction |
![]() |
56.1 | 70 | |(% style="width:208px" %)[[attach:ContractBilling_[1.3].xsd||target="_blank"]]|(% style="width:213px" %)1.3|(% style="width:288px" %)2022-04-26|(% style="width:585px" %)((( |
71 | Added support for new eCurrencyTypes USD and GBP | ||
72 | ))) | ||
![]() |
77.1 | 73 | |(% style="width:208px" %)[[ContractBilling_[1.4].xsd>>attach:ContractBilling_[1.X].xsd||target="_blank"]]|(% style="width:213px" %)1.4|(% style="width:288px" %)2022-10-18|(% style="width:585px" %)Updated length of CoAddress and StreetAddress. Extended PXNameAddressString to include diacritics. |
![]() |
84.1 | 74 | |(% style="width:208px" %)[[ContractBilling_[1.X].xsd>>attach:ContractBilling_[1.X].xsd]]|(% style="width:213px" %)1.5|(% style="width:288px" %)2024-05-07|(% style="width:585px" %)Added support for BillingByPayEx |
![]() |
1.1 | 75 | |
76 | == ChangeLog == | ||
77 | |||
78 | (% id="HVersion1.1" %) | ||
79 | ==== **Version 1.0{{id name="3"/}}** ==== | ||
80 | |||
81 | (% id="HJanuary2C2016" %) | ||
82 | ===== April, 2018 ===== | ||
83 | |||
![]() |
25.1 | 84 | [[ContractBilling_[1.0].xsd>>attach:Main.Contract-financing.Technical-reference.WebHome@ContractBilling_[1.0] .xsd]] |
![]() |
1.1 | 85 | |
86 | (% class="box" %) | ||
87 | ((( | ||
88 | Initial version | ||
89 | ))) | ||
90 | ))) | ||
91 | ))) | ||
![]() |
23.1 | 92 | |
93 | |||
94 | (% class="row" %) | ||
95 | ((( | ||
96 | (% class="col-xs-12" %) | ||
97 | ((( | ||
![]() |
40.1 | 98 | ==== **Version 1.1{{id name="3"/}}** ==== |
![]() |
27.1 | 99 | |
![]() |
23.1 | 100 | (% id="HJanuary2C2016" %) |
101 | ===== October, 2021 ===== | ||
102 | |||
![]() |
40.1 | 103 | [[ContractBilling_[1.1].xsd>>attach:Main.Contract-financing.Technical-reference.WebHome@ContractBilling_[1.1].xsd||queryString="rev=1.1"]] |
![]() |
23.1 | 104 | |
105 | (% class="box" %) | ||
106 | ((( | ||
![]() |
24.1 | 107 | Added support for RecurringCard |
108 | Optional elements BillingInfo > PaymentInfo > Clear / Set > Card | ||
![]() |
23.1 | 109 | ))) |
110 | ))) | ||
111 | ))) | ||
112 | |||
![]() |
77.1 | 113 | ==== ==== |
![]() |
47.1 | 114 | |
![]() |
52.1 | 115 | ==== **Version 1.2{{id name="3"/}}** ==== |
![]() |
40.1 | 116 | |
117 | (% id="HJanuary2C2016" %) | ||
118 | ===== April, 2022 ===== | ||
119 | |||
![]() |
48.1 | 120 | [[ContractBilling_[1.2].xsd>>attach:ContractBilling_[1.2].xsd]] |
![]() |
40.1 | 121 | |
122 | (% class="box" %) | ||
123 | ((( | ||
124 | Added support for OffContract. | ||
125 | Added DistributionType that alters the default distribution for the billing instruction | ||
126 | ))) | ||
![]() |
47.1 | 127 | |
128 | |||
![]() |
69.1 | 129 | ==== **Version 1.3{{id name="3"/}}** ==== |
![]() |
47.1 | 130 | |
131 | (% id="HJanuary2C2016" %) | ||
132 | ===== April, 2022 ===== | ||
133 | |||
![]() |
56.1 | 134 | [[attach:ContractBilling_[1.3].xsd||target="_blank"]] |
![]() |
47.1 | 135 | |
![]() |
56.1 | 136 | |
![]() |
47.1 | 137 | (% class="box" %) |
138 | ((( | ||
139 | (% border="0" style="width:1023px" %) | ||
![]() |
70.1 | 140 | |(% style="width:585px" %)Added support for new eCurrencyTypes USD and GBP |
![]() |
47.1 | 141 | ))) |
142 | |||
143 | |||
![]() |
80.1 | 144 | ==== **Version 1.4{{id name="3"/}}** ==== |
![]() |
47.1 | 145 | |
![]() |
69.1 | 146 | (% id="HJanuary2C2016" %) |
147 | ===== October, 2022 ===== | ||
![]() |
47.1 | 148 | |
![]() |
78.1 | 149 | [[ContractBilling_[1.4].xsd>>attach:ContractBilling_[1.X].xsd||target="_blank"]] |
![]() |
47.1 | 150 | |
151 | |||
![]() |
69.1 | 152 | (% class="box" %) |
153 | ((( | ||
154 | (% border="0" style="width:1023px" %) | ||
155 | |(% style="width:585px" %)Updated length of CoAddress and StreetAddress. Extended PXNameAddressString to include diacritics. | ||
156 | ))) | ||
157 | |||
![]() |
78.1 | 158 | ==== ==== |
![]() |
69.1 | 159 | |
![]() |
78.1 | 160 | ==== **Version 1.5{{id name="3"/}}** (Latest) ==== |
![]() |
69.1 | 161 | |
![]() |
78.1 | 162 | (% id="HJanuary2C2016" %) |
163 | ===== Mars, 2024 ===== | ||
![]() |
69.1 | 164 | |
![]() |
83.1 | 165 | [[ContractBilling_[1.X].xsd>>attach:ContractBilling_[1.X].xsd]] |
![]() |
69.1 | 166 | |
![]() |
78.1 | 167 | |
168 | (% class="box" %) | ||
169 | ((( | ||
170 | (% border="0" style="width:1023px" %) | ||
171 | |(% style="width:585px" %)((( | ||
![]() |
81.1 | 172 | Added support for BillingByPayEx to make it possible for PayEx to take over the claim process for contracts. |
173 | |||
174 | Billing instructions (BillInfo) will be executed before BillingByPayEx. | ||
175 | |||
176 | BillingByPayEx 'set' is meant to be sent together with the last billing instruction in the same file. | ||
177 | |||
178 | If BillingByPayEx 'clear' is sent, a new billing instruction cannot be included in the same file, it must be sent with the following file. | ||
![]() |
78.1 | 179 | ))) |
180 | ))) | ||
181 | |||
182 | |||
183 | |||
184 | |||
![]() |
83.1 | 185 |