From empty
To version 33.1
edited by Bent Pitkänen
on 2019/11/13 09:55
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,681 @@
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 closed invoice.
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 +(% class="table-bordered table-striped" %)
363 +|=(% colspan="4" %)GetClosedInvoiceInformationByCustomerNoResponse
364 +|**Field**|**Datatype**|**Description**
365 +|##CompanyNo##|String|
366 +|##CustomerNo##|String|
367 +|##CustomerName##|String|
368 +|InvoiceList|List<ClosedInvoice20>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
369 +
370 += CustomerService methods =
371 +
372 +The complete Wsdl specification for this service can be found at:
373 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
374 +
375 + (Username/password security model)
376 +
377 +== GetcustomerCurrentStateByCustomerNo ==
378 +
379 +Get information about current state of a customer.
380 +
381 +**Class diagram**
382 +
383 +[[image:7-class-diagram-external.png]]
384 +
385 +**Request parameters**
386 +
387 +(% class="table-bordered table-striped" %)
388 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest
389 +|**Field**|**Datatype**|**Required**|**Description**
390 +|##CustomerNumber##|String(15)|Yes|
391 +|##TrackingUserEMail##|String|No|
392 +
393 +**Response parameters**
394 +
395 +(% class="table-bordered table-striped" %)
396 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse
397 +|**Field**|**Datatype**|**Description**
398 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
399 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
400 +|##CustomerNo##|String|
401 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
402 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
403 +
404 +**Classes**
405 +
406 +(% class="table-bordered table-striped" %)
407 +|=(% colspan="3" %)(((
408 +==== CustomerConsent ====
409 +)))
410 +|**Field**|**Datatype**|**Description**
411 +|(% 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.
412 +
413 +(% class="table-bordered table-striped" %)
414 +|=(% colspan="3" %)(((
415 +==== CustomerInfo ====
416 +)))
417 +|**Field**|**Datatype**|**Description**
418 +|(% style="font-family:monospace" %)##Name##|String|
419 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
420 +|##Language##|String|
421 +|##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.
422 +|##VatNo##|String|
423 +|##Category##| |
424 +
425 +(% class="table-bordered table-striped" %)
426 +|=(% colspan="3" %)(((
427 +==== CustomerStatus ====
428 +)))
429 +|**Field**|**Datatype**|**Description**
430 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|
431 +
432 +(% class="table-bordered table-striped" %)
433 +|=(% colspan="4" %)(((
434 +==== DistributionAddressInfo ====
435 +)))
436 +|**Field**|**Datatype**|**Required**|**Description**
437 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
438 +|##EMailAddress##|String|No|
439 +|##Cellphone##|String|No|
440 +
441 +(% class="table-bordered table-striped" %)
442 +|=(% colspan="4" %)(((
443 +==== Address ====
444 +)))
445 +|**Field**|**Datatype**|**Required**|**Description**
446 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
447 +|##StreetAdress##|String(35)|No|
448 +|##ZipCode##|String(9)|Yes|
449 +|##City##|String(27)|Yes|
450 +|##CoAddress##|String(35)|No|
451 +|##CountryCode##|String(2)|Yes|
452 +
453 +(% id="HAppendix1SharedClasses" %)
454 += Appendix 1 Shared Classes =
455 +
456 +
457 +**Response parameters**
458 +
459 +(% class="table-bordered table-striped" %)
460 +|=(% colspan="3" %)(((
461 +==== GetInvoicePDFResponse ====
462 +)))
463 +|**Field**|**Datatype**|**Description**
464 +|##Pdf##|Byte[]|
465 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
466 +|##CustomerNo##|String|
467 +|##ResponseCode##|String|
468 +|##ResponseMessage##|String|
469 +|##TraceId##|String|
470 +
471 +(% class="table-bordered table-striped" %)
472 +|=(% colspan="3" %)(((
473 +==== GetInvoiceInformationResponse ====
474 +)))
475 +|**Field**|**Datatype**|**Description**
476 +|##CompanyNo##|String|
477 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
478 +|##CustomerNo##|String|
479 +|##CustomerName##|String|
480 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
481 +|##ResponseCode##|String|
482 +|##ResponseMessage##|String|
483 +|##TraceId##|String|
484 +
485 +(% class="table-bordered table-striped" %)
486 +|=(% colspan="3" %)(((
487 +==== RegNo ====
488 +)))
489 +|**Field**|**Datatype**|**Description**
490 +|##CountryCode##|String|
491 +|##Value##|String|
492 +
493 +(% class="table-bordered table-striped" %)
494 +|=(% colspan="3" %)(((
495 +==== Invoice ====
496 +)))
497 +|**Field**|**Datatype**|**Description**
498 +|##PaymentReference##|String|
499 +|##BillNo##|String|
500 +|##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.
501 +|##ExternalInvoiceId##|String|
502 +|##ExternalReference##|String|
503 +|##SellerNo##|String|
504 +|##BillDate##|DateTime|
505 +|##DueDate##|DateTime (Optional)|
506 +|##OriginalAmount##|Decimal|
507 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
508 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
509 +|##CurrencyCode##|String|
510 +|##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.
511 +|##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.
512 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
513 +|##PaymentType##|String|
514 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
515 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
516 +|##BillId##|Long|
517 +|##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.
518 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
519 +
520 +(% class="table-bordered table-striped" %)
521 +|=(% colspan="3" %)(((
522 +==== Interest ====
523 +)))
524 +|**Field**|**Datatype**|**Description**
525 +|##CurrentInterestRate##|decimal|
526 +|##InterestIntervalCode##|byte|
527 +
528 +(% class="table-bordered table-striped" %)
529 +|=(% colspan="3" %)(((
530 +==== Balance ====
531 +)))
532 +|**Field**|**Datatype**|**Description**
533 +|##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.
534 +|##Amount##|decimal|
535 +
536 +(% class="table-bordered table-striped" %)
537 +|=(% colspan="3" %)(((
538 +==== PaymentBankAccount ====
539 +)))
540 +|**Field**|**Datatype**|**Description**
541 +|##BankAccountNo##|String|
542 +|##BankAccountType##|String|
543 +|##BIC##|String|
544 +|##IBAN##|String|
545 +
546 +(% class="table-bordered table-striped" %)
547 +|=(% colspan="3" %)(((
548 +==== ActiveRespite ====
549 +)))
550 +|**Field**|**Datatype**|**Description**
551 +|##RespiteValidtoDate##|DateTime|
552 +|##RespiteTypeCode##|int|
553 +
554 +(% class="table-bordered table-striped" %)
555 +|=(% colspan="3" %)(((
556 +==== ActivePaymentOrder ====
557 +)))
558 +|**Field**|**Datatype**|**Description**
559 +|##PaymentType##|String|
560 +|##ExecutionDate##|DateTime|
561 +
562 +(% class="table-bordered table-striped" %)
563 +|=(% colspan="3" %)(((
564 +==== InvoiceHistory ====
565 +)))
566 +|**Field**|**Datatype**|**Description**
567 +|BillDate|DateTime|
568 +|BillId|long|
569 +|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.
570 +
571 +(% class="table-bordered table-striped" %)
572 +|=(% colspan="3" %)(((
573 +==== ClosedInvoice20 ====
574 +)))
575 +|**Field**|**Datatype**|**Description**
576 +|CurrencyCode|String|
577 +|BillNo|string|
578 +|BillStatusCode|Int|
579 +|ExternalInvoiceId|String|
580 +|BillDate|DateTime|
581 +|DueDate|DateTime?|
582 +|ExternalBillType|String|
583 +|OriginalAmount|Decimal|
584 +|SellerName|String|
585 +|SellerNo|String|
586 +
587 += Appendix 2 Code specification =
588 +
589 +(% class="table-bordered table-striped" %)
590 +|=(% colspan="2" %)(((
591 +==== Bill status codes ====
592 +)))
593 +|**BillStatusCodes**|**Description**
594 +|1|Open
595 +|2|Closed
596 +|3|Closed_Diff
597 +|4|Closed_Loss
598 +|5|Reversed
599 +|6|Arrears
600 +|7|Closed_Rest
601 +|8|Closed_Convert
602 +|9|Closed_Sold
603 +|10|Closed_Reversal
604 +|11|Pending
605 +
606 +(% class="table-bordered table-striped" %)
607 +|=(% colspan="2" %)(((
608 +==== Claim level codes ====
609 +)))
610 +|**ClaimLevelCode**|**Description**
611 +|1|Invoice
612 +|2|RestReminderSent
613 +|3|ReminderSent
614 +|4|RestReminderSent
615 +|5|SecondReminderSent
616 +|6|RestReminderSent
617 +|7|CollectionClaimSent
618 +|8|RestReminderSent
619 +|9*|DebtCollection*
620 +|10|Late Fee, credit account
621 +|11|TerminationNoticeSent, credit account
622 +
623 +*Additional fees and interest may have occured in collection system, but is not included in the response.
624 +
625 +(% class="table-bordered table-striped" %)
626 +|=(% colspan="2" %)(((
627 +==== Bill type codes ====
628 +)))
629 +|**BillTypeCode**|**Description**
630 +|1|Invoice
631 +|4|CreditInvoice
632 +
633 +(% class="table-bordered table-striped" %)
634 +|=(% colspan="2" %)(((
635 +==== Consent type codes ====
636 +)))
637 +|**ConsentTypeCode**|**Description**
638 +|1|BGAGSE
639 +|2|EInvoiceB2CSE
640 +|3|EInvoiceB2CNO
641 +|4|BKAGNO
642 +
643 +(% class="table-bordered table-striped" %)
644 +|=(% colspan="2" %)(((
645 +==== Legal entity codes ====
646 +)))
647 +|**LegalEntiytCode**|**Description**
648 +|None|None
649 +|Private|Private
650 +|Business|Business
651 +
652 +(% class="table-bordered table-striped" %)
653 +|=(% colspan="2" %)(((
654 +==== Balance type codes ====
655 +)))
656 +|**BalanceTypeCode**|**Description**
657 +|0|None
658 +|1|Capital
659 +|2|ReminderFee
660 +|3|PenaltyInterest
661 +|4|CalculatedPenaltyInterest
662 +|5|CollectionFee
663 +|6|BusinessReminderFee
664 +|7|BillingFee
665 +|8|DelayFee
666 +|9|DebtInterest
667 +|10|DebtCollectionCharge
668 +|11|Rounding
669 +
670 +(% class="table-bordered table-striped" %)
671 +|=(% colspan="2" %)(((
672 +==== Collection status codes ====
673 +)))
674 +|**CollectionStatusCode**|**Description**
675 +|1|PreDebtCollection
676 +|2|DebtCollection
677 +|3|LegalProcess
678 +|4|Monitoring
679 +|5|External
680 +|6|Closed
681 +|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
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