Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 22.1
edited by Bent Pitkänen
on 2019/11/12 15:48
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,572 @@
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 +
276 +
277 += CustomerService methods =
278 +
279 +The complete Wsdl specification for this service can be found at:
280 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
281 +
282 + (Username/password security model)
283 +
284 +== GetcustomerCurrentStateByCustomerNo ==
285 +
286 +Get information about current state of a customer.
287 +
288 +**Class diagram**
289 +
290 +[[image:7-class-diagram-external.png]]
291 +
292 +**Request parameters**
293 +
294 +(% class="table-bordered table-striped" %)
295 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest
296 +|**Field**|**Datatype**|**Required**|**Description**
297 +|##CustomerNumber##|String(15)|Yes|
298 +|##TrackingUserEMail##|String|No|
299 +
300 +**Response parameters**
301 +
302 +(% class="table-bordered table-striped" %)
303 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse
304 +|**Field**|**Datatype**|**Description**
305 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
306 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
307 +|##CustomerNo##|String|
308 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
309 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
310 +
311 +**Classes**
312 +
313 +(% class="table-bordered table-striped" %)
314 +|=(% colspan="3" %)(((
315 +==== CustomerConsent ====
316 +)))
317 +|**Field**|**Datatype**|**Description**
318 +|(% 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.
319 +
320 +(% class="table-bordered table-striped" %)
321 +|=(% colspan="3" %)(((
322 +==== CustomerInfo ====
323 +)))
324 +|**Field**|**Datatype**|**Description**
325 +|(% style="font-family:monospace" %)##Name##|String|
326 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
327 +|##Language##|String|
328 +|##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.
329 +|##VatNo##|String|
330 +|##Category##| |
331 +
332 +(% class="table-bordered table-striped" %)
333 +|=(% colspan="3" %)(((
334 +==== CustomerStatus ====
335 +)))
336 +|**Field**|**Datatype**|**Description**
337 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|
338 +
339 +(% class="table-bordered table-striped" %)
340 +|=(% colspan="4" %)(((
341 +==== DistributionAddressInfo ====
342 +)))
343 +|**Field**|**Datatype**|**Required**|**Description**
344 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
345 +|##EMailAddress##|String|No|
346 +|##Cellphone##|String|No|
347 +
348 +(% class="table-bordered table-striped" %)
349 +|=(% colspan="4" %)(((
350 +==== Address ====
351 +)))
352 +|**Field**|**Datatype**|**Required**|**Description**
353 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
354 +|##StreetAdress##|String(35)|No|
355 +|##ZipCode##|String(9)|Yes|
356 +|##City##|String(27)|Yes|
357 +|##CoAddress##|String(35)|No|
358 +|##CountryCode##|String(2)|Yes|
359 +
360 +(% id="HAppendix1SharedClasses" %)
361 += Appendix 1 Shared Classes =
362 +
363 +
364 +**Response parameters**
365 +
366 +(% class="table-bordered table-striped" %)
367 +|=(% colspan="3" %)(((
368 +==== GetInvoicePDFResponse ====
369 +)))
370 +|**Field**|**Datatype**|**Description**
371 +|##Pdf##|Byte[]|
372 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
373 +|##CustomerNo##|String|
374 +|##ResponseCode##|String|
375 +|##ResponseMessage##|String|
376 +|##TraceId##|String|
377 +
378 +(% class="table-bordered table-striped" %)
379 +|=(% colspan="3" %)(((
380 +==== GetInvoiceInformationResponse ====
381 +)))
382 +|**Field**|**Datatype**|**Description**
383 +|##CompanyNo##|String|
384 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
385 +|##CustomerNo##|String|
386 +|##CustomerName##|String|
387 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
388 +|##ResponseCode##|String|
389 +|##ResponseMessage##|String|
390 +|##TraceId##|String|
391 +
392 +(% class="table-bordered table-striped" %)
393 +|=(% colspan="3" %)(((
394 +==== RegNo ====
395 +)))
396 +|**Field**|**Datatype**|**Description**
397 +|##CountryCode##|String|
398 +|##Value##|String|
399 +
400 +(% class="table-bordered table-striped" %)
401 +|=(% colspan="3" %)(((
402 +==== Invoice ====
403 +)))
404 +|**Field**|**Datatype**|**Description**
405 +|##PaymentReference##|String|
406 +|##BillNo##|String|
407 +|##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.
408 +|##ExternalInvoiceId##|String|
409 +|##ExternalReference##|String|
410 +|##SellerNo##|String|
411 +|##BillDate##|DateTime|
412 +|##DueDate##|DateTime (Optional)|
413 +|##OriginalAmount##|Decimal|
414 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
415 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
416 +|##CurrencyCode##|String|
417 +|##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.
418 +|##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.
419 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
420 +|##PaymentType##|String|
421 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
422 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
423 +|##BillId##|Long|
424 +|##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.
425 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
426 +
427 +(% class="table-bordered table-striped" %)
428 +|=(% colspan="3" %)(((
429 +==== Interest ====
430 +)))
431 +|**Field**|**Datatype**|**Description**
432 +|##CurrentInterestRate##|decimal|
433 +|##InterestIntervalCode##|byte|
434 +
435 +(% class="table-bordered table-striped" %)
436 +|=(% colspan="3" %)(((
437 +==== Balance ====
438 +)))
439 +|**Field**|**Datatype**|**Description**
440 +|##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.
441 +|##Amount##|decimal|
442 +
443 +(% class="table-bordered table-striped" %)
444 +|=(% colspan="3" %)(((
445 +==== PaymentBankAccount ====
446 +)))
447 +|**Field**|**Datatype**|**Description**
448 +|##BankAccountNo##|String|
449 +|##BankAccountType##|String|
450 +|##BIC##|String|
451 +|##IBAN##|String|
452 +
453 +(% class="table-bordered table-striped" %)
454 +|=(% colspan="3" %)(((
455 +==== ActiveRespite ====
456 +)))
457 +|**Field**|**Datatype**|**Description**
458 +|##RespiteValidtoDate##|DateTime|
459 +|##RespiteTypeCode##|int|
460 +
461 +(% class="table-bordered table-striped" %)
462 +|=(% colspan="3" %)(((
463 +==== ActivePaymentOrder ====
464 +)))
465 +|**Field**|**Datatype**|**Description**
466 +|##PaymentType##|String|
467 +|##ExecutionDate##|DateTime|
468 +
469 +(% class="table-bordered table-striped" %)
470 +|=(% colspan="3" %)(((
471 +==== InvoiceHistory ====
472 +)))
473 +|**Field**|**Datatype**|**Description**
474 +|BillDate|DateTime|
475 +|BillId|long|
476 +|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.
477 +
478 += Appendix 2 Code specification =
479 +
480 +(% class="table-bordered table-striped" %)
481 +|=(% colspan="2" %)(((
482 +==== Bill status codes ====
483 +)))
484 +|**BillStatusCodes**|**Description**
485 +|1|Open
486 +|2|Closed
487 +|3|Closed_Diff
488 +|4|Closed_Loss
489 +|5|Reversed
490 +|6|Arrears
491 +|7|Closed_Rest
492 +|8|Closed_Convert
493 +|9|Closed_Sold
494 +|10|Closed_Reversal
495 +|11|Pending
496 +
497 +(% class="table-bordered table-striped" %)
498 +|=(% colspan="2" %)(((
499 +==== Claim level codes ====
500 +)))
501 +|**ClaimLevelCode**|**Description**
502 +|1|Invoice
503 +|2|RestReminderSent
504 +|3|ReminderSent
505 +|4|RestReminderSent
506 +|5|SecondReminderSent
507 +|6|RestReminderSent
508 +|7|CollectionClaimSent
509 +|8|RestReminderSent
510 +|9*|DebtCollection*
511 +|10|Late Fee, credit account
512 +|11|TerminationNoticeSent, credit account
513 +
514 +*Additional fees and interest may have occured in collection system, but is not included in the response.
515 +
516 +(% class="table-bordered table-striped" %)
517 +|=(% colspan="2" %)(((
518 +==== Bill type codes ====
519 +)))
520 +|**BillTypeCode**|**Description**
521 +|1|Invoice
522 +|4|CreditInvoice
523 +
524 +(% class="table-bordered table-striped" %)
525 +|=(% colspan="2" %)(((
526 +==== Consent type codes ====
527 +)))
528 +|**ConsentTypeCode**|**Description**
529 +|1|BGAGSE
530 +|2|EInvoiceB2CSE
531 +|3|EInvoiceB2CNO
532 +|4|BKAGNO
533 +
534 +(% class="table-bordered table-striped" %)
535 +|=(% colspan="2" %)(((
536 +==== Legal entity codes ====
537 +)))
538 +|**LegalEntiytCode**|**Description**
539 +|None|None
540 +|Private|Private
541 +|Business|Business
542 +
543 +(% class="table-bordered table-striped" %)
544 +|=(% colspan="2" %)(((
545 +==== Balance type codes ====
546 +)))
547 +|**BalanceTypeCode**|**Description**
548 +|0|None
549 +|1|Capital
550 +|2|ReminderFee
551 +|3|PenaltyInterest
552 +|4|CalculatedPenaltyInterest
553 +|5|CollectionFee
554 +|6|BusinessReminderFee
555 +|7|BillingFee
556 +|8|DelayFee
557 +|9|DebtInterest
558 +|10|DebtCollectionCharge
559 +|11|Rounding
560 +
561 +(% class="table-bordered table-striped" %)
562 +|=(% colspan="2" %)(((
563 +==== Collection status codes ====
564 +)))
565 +|**CollectionStatusCode**|**Description**
566 +|1|PreDebtCollection
567 +|2|DebtCollection
568 +|3|LegalProcess
569 +|4|Monitoring
570 +|5|External
571 +|6|Closed
572 +|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
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