Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 44.1
edited by Bent Pitkänen
on 2019/11/13 13:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +ExternalServicesmanual
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.bpi
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,715 @@
1 += =
2 +
3 +(% class="jumbotron" %)
4 +(((
5 +(% class="container" %)
6 +(((
7 +The external services manual cover methods used to retrieve Invoice PDFs as well as invoice and customer information.
8 +)))
9 +)))
10 +
11 +**You can also use the PDF manual found [[here>>attach:PayExConnect_Manual_PxR_ExternalServices.pdf]].**
12 +
13 += InvoiceService methods =
14 +
15 +The complete Wsdl specification for this service can be found at:
16 +
17 +[[https:~~/~~/connect.payex.com~~/~~/PxR/InvoiceService.svc?wsdl>>url:https://connect.payex.com//PxR/InvoiceService.svc?wsdl]]
18 +
19 + (Username/password security model)
20 +
21 +== GetInvoicePdfByBillNo ==
22 +
23 +(% class="wikigeneratedid" %)
24 +Gets a specific invoice document in the format of PDF
25 +
26 +**Class diagram**
27 +
28 +**[[image:1-class-diagram-external.png]]**
29 +
30 +**Request parameters**
31 +
32 +(% class="table-bordered table-striped" %)
33 +|=(% colspan="4" %)GetInvoiceByBillNoRequest
34 +|**Field**|**Datatype**|**Required**|**Description**
35 +|##BillNo##|String(15)|Yes|
36 +|##TrackingUserEmail##|Sting(50)|Yes|User info for trackability.
37 +|##TraceId##|String|Yes|
38 +
39 +(% class="wikigeneratedid" %)
40 +**Response parameters**
41 +
42 +(% class="wikigeneratedid" %)
43 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]]
44 +
45 +== GetInvoicePdfByExternalInvoiceId ==
46 +
47 +Gets a specific invoice document in the format of PDF
48 +
49 +**Class diagram**
50 +
51 +**[[image:2-class-diagram-external.png]]**
52 +
53 +**Request parameters**
54 +
55 +(% class="table-bordered table-striped" %)
56 +|=(% colspan="4" %)GetInvoicePdfByExternalInvoiceIdRequest
57 +|**Field**|**Datatype**|**Required**|**Description**
58 +|##ExternalInvoiceId##|String(15)|Yes|
59 +|TrackingUserEmail|String(50)|Yes|User info for trackability.
60 +|TraceId|String|Yes|
61 +
62 +(% class="wikigeneratedid" %)
63 +**Response parameters**
64 +
65 +(% class="wikigeneratedid" %)
66 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]]
67 +
68 +== GetInvoiceInformationByBillNo ==
69 +
70 +Gets information about a specific invoice
71 +
72 +**Class diagram**
73 +
74 +**[[image:3-class-diagram-external.png]]**
75 +
76 +**Request parameters**
77 +
78 +(% class="table-bordered table-striped" %)
79 +|=(% colspan="4" %)GetInvoiceInformationByBillNoRequest
80 +|**Field**|**Datatype**|**Required**|**Description**
81 +|##BillNo##|String(15)|Yes|
82 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability.
83 +|##TraceId##|String|Yes|
84 +
85 +(% class="wikigeneratedid" %)
86 +**Response parameters**
87 +
88 +(% class="wikigeneratedid" %)
89 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
90 +
91 +== GetInvoiceIformationByExternalInvoiceId ==
92 +
93 +Gets information about a specific invoice
94 +
95 +**Class diagram**
96 +
97 +**[[image:4-class-diagram-external.png]]**
98 +
99 +**Request parameters**
100 +
101 +(% class="table-bordered table-striped" %)
102 +|=(% colspan="4" %)GetInvoiceByExternalInvoiceIdRequest
103 +|**Field**|**Datatype**|**Required**|**Description**
104 +|ExternalInvoiceId|String (15)|Yes|
105 +|TrackingUserEmail|String (50)|Yes|User info for trackability.
106 +|TraceId|String|Yes|
107 +
108 +(% class="wikigeneratedid" %)
109 +**Response parameters**
110 +
111 +(% class="wikigeneratedid" %)
112 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
113 +
114 +== GetOpenInvoiceInformationByCustomerNo ==
115 +
116 +Gets open invoices
117 +
118 +**Class diagram**
119 +
120 +**[[image:5-class-diagram-external.png]]**
121 +
122 +**Request parameters**
123 +
124 +(% class="table-bordered table-striped" %)
125 +|=(% colspan="4" %)GetOpenInvoiceInformationByCustomerNoRequest
126 +|**Field**|**Datatype**|**Required**|**Description**
127 +|##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer.
128 +|##TrackingUserEMail##|String|No|User info for trackability.
129 +|##TraceId##|String|Yes|
130 +
131 +**Response parameters**
132 +
133 +(% class="table-bordered table-striped" %)
134 +|=(% colspan="3" %)GetOpenInvoiceInformationByCustomerNoResponse
135 +|**Field**|**Datatype**|**Description**
136 +|##CompanyNo##|String|
137 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
138 +|##CustomerName##|String|
139 +|##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>|
140 +|##ResponseCode##|String|
141 +|##ResponseMessage##|String|
142 +|##TraceId##|String|
143 +
144 +**Classes**
145 +
146 +(% class="table-bordered table-striped" %)
147 +|=(% colspan="3" %)(((
148 +==== OpenInvoice ====
149 +)))
150 +|**Field**|**Datatype**|**Description**
151 +|(% style="font-family:monospace" %)BillNo|String|
152 +|##BillStatusCode##|Int|See the [[bill status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBillstatuscodes"]] for available status codes.
153 +|##ExternalInvoiceId##|String|Additional unique invoice identifier.
154 +|##BillDate##|DateTime|
155 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
156 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes.
157 +|##OriginalAmount##|Decimal|
158 +|##CurrentDebt##|Decimal|
159 +|##CurrencyCode##|String|
160 +|##CurrentClaimLevelCode##|Int|See the [[claim level code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClaimlevelcodes"]] for available claim level codes.
161 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
162 +|##PaymentType##|String|
163 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
164 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
165 +
166 +== GetClosedInvoiceInformationByCustomerNo ==
167 +
168 +Gets closed invoices (status “Closed” only)
169 +
170 +**Class diagram**
171 +
172 +**[[image:6-class-diagram-external.png]]**
173 +
174 +**Request parameters**
175 +
176 +(% class="table-bordered table-striped" %)
177 +|=(% colspan="4" %)GetClosedInvoiceInformationCustomerNoRequest
178 +|**Field**|**Datatype**|**Required**|**Description**
179 +|##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer.
180 +|##TrackingUserEMail##|String|No|User info for trackability.
181 +|##TraceId##|String|Yes|
182 +
183 +**Response parameters**
184 +
185 +(% class="table-bordered table-striped" %)
186 +|=(% colspan="3" %)GetClosedInvoiceInformationByCustomerNoResponse
187 +|**Field**|**Datatype**|**Description**
188 +|##CompanyNo##|String|Yoyr accounts receivable number at PayEx.
189 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
190 +|##CustomerName##|String|
191 +|##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>|
192 +|##ResponseCode##|String|
193 +|##ResponseMessage##|String|
194 +|##TraceId##|String|
195 +
196 +**Classes**
197 +
198 +(% class="table-bordered table-striped" %)
199 +|=(% colspan="3" %)(((
200 +==== ClosedInvoice ====
201 +)))
202 +|**Field**|**Datatype**|**Description**
203 +|(% style="font-family:monospace" %)BillNo|String|
204 +|##BillStatusCode##|Int|See the [[bill status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBillstatuscodes"]] for available status codes.
205 +|##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable.
206 +|##BillDate##|DateTime|
207 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
208 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes.
209 +|##OriginalAmount##|Decimal|
210 +|##CurrencyCode##|String|
211 +
212 +== AddInvoiceRespiteByBillNo10 ==
213 +
214 +Add respite date to an open invoice.
215 +
216 +**Class diagram**
217 +[[image:1573563792142-225.png||height="318" width="920"]]
218 +**Request parameters**
219 +
220 +(% class="table-bordered table-striped" %)
221 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Request
222 +|**Field**|**Datatype**|**Required**|**Description**
223 +|##BillNo##|String(15)|Yes|Bill Number.
224 +|##RespiteCause##|String(250)|Yes|Reason for respite.
225 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
226 +|##TraceId##|String|Yes|
227 +|##ValidToDate##|DateTime|Yes|
228 +
229 +**Response parameters**
230 +
231 +(% class="table-bordered table-striped" %)
232 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Response
233 +|**Field**|**Datatype**|**Description**
234 +|##ResponseCode##|String|
235 +|##ResponseMessage##|String|
236 +|##TraceId##|String|
237 +
238 +**Error codes**
239 +
240 +(% class="table-bordered table-striped" %)
241 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
242 +|**Code**|**Name**|**Description**
243 +|##5074##|InvalidDate|ValidToDate is not within a valid date.
244 +|##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType.
245 +|##1208##|InvalidAccountStatus|Respite not a valid action on this bill.
246 +
247 +== ConvertInvoiceToAccount10 ==
248 +
249 +Convert an invoice account to a credit account.
250 +
251 +**Class diagram**
252 +
253 +[[image:1573569373687-299.png||height="324" width="739"]]
254 +
255 +**Request parameters**
256 +
257 +(% class="table-bordered table-striped" %)
258 +|=(% colspan="4" %)ConvertInvoiceToAccount10Request
259 +|**Field**|**Datatype**|**Required**|**Description**
260 +|##BillNo##|String(15)|Yes|Bill Number.
261 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
262 +|##TraceId##|String|Yes|
263 +
264 +**Response parameters**
265 +
266 +(% class="table-bordered table-striped" %)
267 +|=(% colspan="4" %)ConvertInvoiceToAccount10Response
268 +|**Field**|**Datatype**|**Description**
269 +|##ResponseCode##|String|
270 +|##ResponseMessage##|String|
271 +|##TraceId##|String|
272 +
273 +== RegisterInvoiceDirectPaymentByBillNo10 ==
274 +
275 +Register a direct payment on given invoice.
276 +
277 +**Class diagram**
278 +
279 +[[image:1573570140844-820.png||height="384" width="715"]]
280 +
281 +**Request parameters**
282 +
283 +(% class="table-bordered table-striped" %)
284 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Request
285 +|**Field**|**Datatype**|**Required**|**Description**
286 +|##Amount##|Decimal|Yes|DirectPayment Amount.
287 +|##BillNo##|String|Yes|Bill to match payment to.
288 +|##PaymentDate##|DateTime|Yes|Date when payment occured.
289 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
290 +|TraceId|String|Yes|
291 +
292 +**Response parameters**
293 +
294 +(% class="table-bordered table-striped" %)
295 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Response
296 +|**Field**|**Datatype**|**Description**
297 +|##ResponseCode##|String|
298 +|##ResponseMessage##|String|
299 +|##TraceId##|String|
300 +
301 +**Error codes**
302 +
303 +(% class="table-bordered table-striped" %)
304 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
305 +|**Code**|**Name**|**Description**
306 +|##5080##|InvalidBillNo|BillNo is invalid
307 +|##1207##|InvalidAmount|Amount is invalid
308 +|##5074##|InvalidDate|PaymentDate is not within a valid date
309 +
310 +== AddInvoiceCopyOrderByBillNo10 ==
311 +
312 +Order a copy of the invoice to be delivered.
313 +
314 +**Class diagram**
315 +
316 +[[image:1573631474317-399.png||height="349" width="795"]]
317 +
318 +**Request parameters**
319 +
320 +(% class="table-bordered table-striped" %)
321 +|=(% colspan="4" %)AddInvoiceCopyOrderByBillNo10Request
322 +|**Field**|**Datatype**|**Required**|**Description**
323 +|##BillNo##|String|Yes|
324 +|##DistributionMethod##|String|Yes|
325 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
326 +|TraceId|String|Yes|
327 +
328 +**Response parameters**
329 +
330 +(% class="table-bordered table-striped" %)
331 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Response
332 +|**Field**|**Datatype**|**Description**
333 +|##ResponseCode##|String|
334 +|##ResponseMessage##|String|
335 +|##TraceId##|String|
336 +
337 +**Error codes**
338 +
339 +(% class="table-bordered table-striped" %)
340 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
341 +|**Code**|**Name**|**Description**
342 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo
343 +
344 +== GetClosedInvoiceInformationByCustomerNo20 ==
345 +
346 +Get information about a customer's closed invoice(s) by customer number.
347 +
348 +**Class diagram**
349 +[[image:1573632921277-742.png||height="509" width="841"]]
350 +
351 +**Request parameters**
352 +
353 +(% class="table-bordered table-striped" %)
354 +|=(% colspan="4" %)GetClosedInvoiceInformationByCustomerNo20Request
355 +|**Field**|**Datatype**|**Required**|**Description**
356 +|##CustomerNo##|String|Yes|
357 +|##TrackingUserEmail##|String|Yes|User info for trackability.
358 +|TraceId| |yes|
359 +
360 +**Response parameters**
361 +
362 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
363 +
364 +== GetClosedInvoiceInformationByRegNo20 ==
365 +
366 +Get information about a customer's closed invoice(s) by social security number.
367 +
368 +**Class diagram**
369 +
370 +[[image:1573646248641-666.png||height="508" width="807"]]
371 +
372 +**Request parameters**
373 +
374 +(% class="table-bordered table-striped" %)
375 +|=(% colspan="4" %)GetClosedInvoiceInformationByRegNo20Request
376 +|**Field**|**Datatype**|**Required**|**Description**
377 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]]
378 +|##TrackingUserEmail##|String|Yes|User info for trackability.
379 +|TraceId| |yes|
380 +
381 +**Response parameters**
382 +
383 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
384 +
385 +**Error codes**
386 +
387 +(% class="table-bordered table-striped" %)
388 +|=(% colspan="4" %)GetClosedInvoiceInformation20Response
389 +|**Code**|**Name**|**Description**
390 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead.
391 +|5075|MissingAccountForBill|Found no matching customer for RegNo.
392 +|1024|ErrorInvalidRegNo|Invalid RegNo format.
393 +
394 += CustomerService methods =
395 +
396 +The complete Wsdl specification for this service can be found at:
397 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
398 +
399 + (Username/password security model)
400 +
401 +== GetcustomerCurrentStateByCustomerNo ==
402 +
403 +Get information about current state of a customer.
404 +
405 +**Class diagram**
406 +
407 +[[image:7-class-diagram-external.png]]
408 +
409 +**Request parameters**
410 +
411 +(% class="table-bordered table-striped" %)
412 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest
413 +|**Field**|**Datatype**|**Required**|**Description**
414 +|##CustomerNumber##|String(15)|Yes|
415 +|##TrackingUserEMail##|String|No|
416 +
417 +**Response parameters**
418 +
419 +(% class="table-bordered table-striped" %)
420 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse
421 +|**Field**|**Datatype**|**Description**
422 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
423 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
424 +|##CustomerNo##|String|
425 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
426 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
427 +
428 +**Classes**
429 +
430 +(% class="table-bordered table-striped" %)
431 +|=(% colspan="3" %)(((
432 +==== CustomerConsent ====
433 +)))
434 +|**Field**|**Datatype**|**Description**
435 +|(% style="font-family:monospace" %)##ConsentTypeCode##|Int|See the [[consent type codes>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HConsenttypecodes"]] table for available consent type codes.
436 +
437 +(% class="table-bordered table-striped" %)
438 +|=(% colspan="3" %)(((
439 +==== CustomerInfo ====
440 +)))
441 +|**Field**|**Datatype**|**Description**
442 +|(% style="font-family:monospace" %)##Name##|String|
443 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
444 +|##Language##|String|
445 +|##LegalEntityCode##|Int|See the [[legal entity codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HLegalentitycodes"]] for available legal entity codes.
446 +|##VatNo##|String|
447 +|##Category##| |
448 +
449 +(% class="table-bordered table-striped" %)
450 +|=(% colspan="3" %)(((
451 +==== CustomerStatus ====
452 +)))
453 +|**Field**|**Datatype**|**Description**
454 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|
455 +
456 +(% class="table-bordered table-striped" %)
457 +|=(% colspan="4" %)(((
458 +==== DistributionAddressInfo ====
459 +)))
460 +|**Field**|**Datatype**|**Required**|**Description**
461 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
462 +|##EMailAddress##|String|No|
463 +|##Cellphone##|String|No|
464 +
465 +(% class="table-bordered table-striped" %)
466 +|=(% colspan="4" %)(((
467 +==== Address ====
468 +)))
469 +|**Field**|**Datatype**|**Required**|**Description**
470 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
471 +|##StreetAdress##|String(35)|No|
472 +|##ZipCode##|String(9)|Yes|
473 +|##City##|String(27)|Yes|
474 +|##CoAddress##|String(35)|No|
475 +|##CountryCode##|String(2)|Yes|
476 +
477 +(% id="HAppendix1SharedClasses" %)
478 += Appendix 1 Shared Classes =
479 +
480 +
481 +**Response parameters**
482 +
483 +(% class="table-bordered table-striped" %)
484 +|=(% colspan="3" %)(((
485 +==== GetInvoicePDFResponse ====
486 +)))
487 +|**Field**|**Datatype**|**Description**
488 +|##Pdf##|Byte[]|
489 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
490 +|##CustomerNo##|String|
491 +|##ResponseCode##|String|
492 +|##ResponseMessage##|String|
493 +|##TraceId##|String|
494 +
495 +(% class="table-bordered table-striped" %)
496 +|=(% colspan="3" %)(((
497 +==== GetInvoiceInformationResponse ====
498 +)))
499 +|**Field**|**Datatype**|**Description**
500 +|##CompanyNo##|String|
501 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
502 +|##CustomerNo##|String|
503 +|##CustomerName##|String|
504 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
505 +|##ResponseCode##|String|
506 +|##ResponseMessage##|String|
507 +|##TraceId##|String|
508 +
509 +(% class="table-bordered table-striped" %)
510 +|=(% colspan="3" %)(((
511 +==== RegNo ====
512 +)))
513 +|**Field**|**Datatype**|**Description**
514 +|##CountryCode##|String|
515 +|##Value##|String|
516 +
517 +(% class="table-bordered table-striped" %)
518 +|=(% colspan="3" %)(((
519 +==== Invoice ====
520 +)))
521 +|**Field**|**Datatype**|**Description**
522 +|##PaymentReference##|String|
523 +|##BillNo##|String|
524 +|##BillStatusCode##|Int|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes.
525 +|##ExternalInvoiceId##|String|
526 +|##ExternalReference##|String|
527 +|##SellerNo##|String|
528 +|##BillDate##|DateTime|
529 +|##DueDate##|DateTime (Optional)|
530 +|##OriginalAmount##|Decimal|
531 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
532 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
533 +|##CurrencyCode##|String|
534 +|##CurrentClaimLevelCode##|Int|See the [[claim level codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClaimlevelcodes"]] for available claim level codes.
535 +|##CollectionStatusCode##|Int|See the [[collection status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCollectionstatuscodes"]] for available collection status codes.
536 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
537 +|##PaymentType##|String|
538 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
539 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
540 +|##BillId##|Long|
541 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes.
542 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
543 +
544 +(% class="table-bordered table-striped" %)
545 +|=(% colspan="3" %)(((
546 +==== Interest ====
547 +)))
548 +|**Field**|**Datatype**|**Description**
549 +|##CurrentInterestRate##|decimal|
550 +|##InterestIntervalCode##|byte|
551 +
552 +(% class="table-bordered table-striped" %)
553 +|=(% colspan="3" %)(((
554 +==== Balance ====
555 +)))
556 +|**Field**|**Datatype**|**Description**
557 +|##BalanceTypeCode##|int|See the [[balance type codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalancetypecodes"]] for available balance type codes.
558 +|##Amount##|decimal|
559 +
560 +(% class="table-bordered table-striped" %)
561 +|=(% colspan="3" %)(((
562 +==== PaymentBankAccount ====
563 +)))
564 +|**Field**|**Datatype**|**Description**
565 +|##BankAccountNo##|String|
566 +|##BankAccountType##|String|
567 +|##BIC##|String|
568 +|##IBAN##|String|
569 +
570 +(% class="table-bordered table-striped" %)
571 +|=(% colspan="3" %)(((
572 +==== ActiveRespite ====
573 +)))
574 +|**Field**|**Datatype**|**Description**
575 +|##RespiteValidtoDate##|DateTime|
576 +|##RespiteTypeCode##|int|
577 +
578 +(% class="table-bordered table-striped" %)
579 +|=(% colspan="3" %)(((
580 +==== ActivePaymentOrder ====
581 +)))
582 +|**Field**|**Datatype**|**Description**
583 +|##PaymentType##|String|
584 +|##ExecutionDate##|DateTime|
585 +
586 +(% class="table-bordered table-striped" %)
587 +|=(% colspan="3" %)(((
588 +==== InvoiceHistory ====
589 +)))
590 +|**Field**|**Datatype**|**Description**
591 +|BillDate|DateTime|
592 +|BillId|long|
593 +|BillTypeCode|byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes.
594 +
595 +(% class="table-bordered table-striped" %)
596 +|=(% colspan="3" %)(((
597 +==== GetClosedInvoiceInformation20Response ====
598 +)))
599 +|**Field**|**Datatype**|**Description**
600 +|CompanyNo|String|
601 +|CustomerNo|string|
602 +|CustomerName|String|
603 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
604 +
605 +(% class="table-bordered table-striped" %)
606 +|=(% colspan="3" %)(((
607 +==== ClosedInvoice20 ====
608 +)))
609 +|**Field**|**Datatype**|**Description**
610 +|CurrencyCode|String|
611 +|BillNo|string|
612 +|BillStatusCode|Int|
613 +|ExternalInvoiceId|String|
614 +|BillDate|DateTime|
615 +|DueDate|DateTime?|
616 +|ExternalBillType|String|
617 +|OriginalAmount|Decimal|
618 +|SellerName|String|
619 +|SellerNo|String|
620 +
621 += Appendix 2 Code specification =
622 +
623 +(% class="table-bordered table-striped" %)
624 +|=(% colspan="2" %)(((
625 +==== Bill status codes ====
626 +)))
627 +|**BillStatusCodes**|**Description**
628 +|1|Open
629 +|2|Closed
630 +|3|Closed_Diff
631 +|4|Closed_Loss
632 +|5|Reversed
633 +|6|Arrears
634 +|7|Closed_Rest
635 +|8|Closed_Convert
636 +|9|Closed_Sold
637 +|10|Closed_Reversal
638 +|11|Pending
639 +
640 +(% class="table-bordered table-striped" %)
641 +|=(% colspan="2" %)(((
642 +==== Claim level codes ====
643 +)))
644 +|**ClaimLevelCode**|**Description**
645 +|1|Invoice
646 +|2|RestReminderSent
647 +|3|ReminderSent
648 +|4|RestReminderSent
649 +|5|SecondReminderSent
650 +|6|RestReminderSent
651 +|7|CollectionClaimSent
652 +|8|RestReminderSent
653 +|9*|DebtCollection*
654 +|10|Late Fee, credit account
655 +|11|TerminationNoticeSent, credit account
656 +
657 +*Additional fees and interest may have occured in collection system, but is not included in the response.
658 +
659 +(% class="table-bordered table-striped" %)
660 +|=(% colspan="2" %)(((
661 +==== Bill type codes ====
662 +)))
663 +|**BillTypeCode**|**Description**
664 +|1|Invoice
665 +|4|CreditInvoice
666 +
667 +(% class="table-bordered table-striped" %)
668 +|=(% colspan="2" %)(((
669 +==== Consent type codes ====
670 +)))
671 +|**ConsentTypeCode**|**Description**
672 +|1|BGAGSE
673 +|2|EInvoiceB2CSE
674 +|3|EInvoiceB2CNO
675 +|4|BKAGNO
676 +
677 +(% class="table-bordered table-striped" %)
678 +|=(% colspan="2" %)(((
679 +==== Legal entity codes ====
680 +)))
681 +|**LegalEntiytCode**|**Description**
682 +|None|None
683 +|Private|Private
684 +|Business|Business
685 +
686 +(% class="table-bordered table-striped" %)
687 +|=(% colspan="2" %)(((
688 +==== Balance type codes ====
689 +)))
690 +|**BalanceTypeCode**|**Description**
691 +|0|None
692 +|1|Capital
693 +|2|ReminderFee
694 +|3|PenaltyInterest
695 +|4|CalculatedPenaltyInterest
696 +|5|CollectionFee
697 +|6|BusinessReminderFee
698 +|7|BillingFee
699 +|8|DelayFee
700 +|9|DebtInterest
701 +|10|DebtCollectionCharge
702 +|11|Rounding
703 +
704 +(% class="table-bordered table-striped" %)
705 +|=(% colspan="2" %)(((
706 +==== Collection status codes ====
707 +)))
708 +|**CollectionStatusCode**|**Description**
709 +|1|PreDebtCollection
710 +|2|DebtCollection
711 +|3|LegalProcess
712 +|4|Monitoring
713 +|5|External
714 +|6|Closed
715 +|7|ReturnedWrongAddress
1-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573563792142-225.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573569373687-299.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573570140844-820.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573631474317-399.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573632921277-742.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
1573646248641-666.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.bpi
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
2-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
3-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
4-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
5-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
6-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
7-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PayExConnect_Manual_PxR_ExternalServices.pdf
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.rae
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content