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