Changes for page ExternalServicesmanual
Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 93.1
edited by Simon Melin
on 2019/12/12 16:19
on 2019/12/12 16:19
Change comment: There is no comment for this version
Summary
-
Page properties (6 modified, 0 added, 0 removed)
-
Attachments (0 modified, 26 added, 0 removed)
- 1-class-diagram-external.png
- 1573563792142-225.png
- 1573569373687-299.png
- 1573570140844-820.png
- 1573631474317-399.png
- 1573632921277-742.png
- 1573646248641-666.png
- 1573648586121-179.png
- 1573822272252-854.png
- 1573822789308-786.png
- 1573825242764-218.png
- 1573825460421-413.png
- 1574422177227-663.png
- 1574423356546-688.png
- 1574426401088-684.png
- 1574426572366-122.png
- 1574427881741-366.png
- 1574428685798-189.png
- 1574431509616-621.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
- PxR_InvoiceService_DeletePaymentOrder.png
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.avp - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +px-custom-page-content - Content
-
... ... @@ -1,0 +1,1328 @@ 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 + 12 += InvoiceService methods = 13 + 14 +The complete Wsdl specification for this service can be found at: 15 + 16 +[[https:~~/~~/connect.payex.com/PxR/InvoiceService.svc?wsdl>>https://connect.payex.com/PxR/InvoiceService.svc?wsdl]] 17 + 18 + (Username/password security model) 19 + 20 +== GetInvoicePdfByBillNo == 21 + 22 +(% class="wikigeneratedid" %) 23 +Gets a specific invoice document in the format of PDF 24 + 25 +**Class diagram** 26 + 27 +**[[image:1-class-diagram-external.png]]** 28 + 29 +**Request parameters** 30 + 31 +(% class="table-bordered table-striped" %) 32 +|=(% colspan="4" %)((( 33 +==== GetInvoiceByBillNoRequest ==== 34 +))) 35 +|**Field**|**Datatype**|**Required**|**Description** 36 +|##BillNo##|String(15)|Yes| 37 +|##TrackingUserEmail##|Sting(50)|Yes|User info for trackability. 38 +|##TraceId##|String|Yes| 39 + 40 +(% class="wikigeneratedid" %) 41 +**Response parameters** 42 + 43 +(% class="wikigeneratedid" %) 44 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 45 + 46 +== GetInvoicePdfByExternalInvoiceId == 47 + 48 +Gets a specific invoice document in the format of PDF 49 + 50 +**Class diagram** 51 + 52 +**[[image:2-class-diagram-external.png]]** 53 + 54 +**Request parameters** 55 + 56 +(% class="table-bordered table-striped" %) 57 +|=(% colspan="4" %)((( 58 +==== GetInvoicePdfByExternalInvoiceIdRequest ==== 59 +))) 60 +|**Field**|**Datatype**|**Required**|**Description** 61 +|##ExternalInvoiceId##|String(15)|Yes| 62 +|TrackingUserEmail|String(50)|Yes|User info for trackability. 63 +|TraceId|String|Yes| 64 + 65 +(% class="wikigeneratedid" %) 66 +**Response parameters** 67 + 68 +(% class="wikigeneratedid" %) 69 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 70 + 71 +== GetInvoiceInformationByBillNo == 72 + 73 +Gets information about a specific invoice 74 + 75 +**Class diagram** 76 + 77 +**[[image:3-class-diagram-external.png]]** 78 + 79 +**Request parameters** 80 + 81 +(% class="table-bordered table-striped" %) 82 +|=(% colspan="4" %)((( 83 +==== GetInvoiceInformationByBillNoRequest ==== 84 +))) 85 +|**Field**|**Datatype**|**Required**|**Description** 86 +|##BillNo##|String(15)|Yes| 87 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability. 88 +|##TraceId##|String|Yes| 89 + 90 +(% class="wikigeneratedid" %) 91 +**Response parameters** 92 + 93 +(% class="wikigeneratedid" %) 94 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 95 + 96 +== GetInvoiceIformationByExternalInvoiceId == 97 + 98 +Gets information about a specific invoice 99 + 100 +**Class diagram** 101 + 102 +**[[image:4-class-diagram-external.png]]** 103 + 104 +**Request parameters** 105 + 106 +(% class="table-bordered table-striped" %) 107 +|=(% colspan="4" %)((( 108 +==== GetInvoiceByExternalInvoiceIdRequest ==== 109 +))) 110 +|**Field**|**Datatype**|**Required**|**Description** 111 +|ExternalInvoiceId|String (15)|Yes| 112 +|TrackingUserEmail|String (50)|Yes|User info for trackability. 113 +|TraceId|String|Yes| 114 + 115 +(% class="wikigeneratedid" %) 116 +**Response parameters** 117 + 118 +(% class="wikigeneratedid" %) 119 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 120 + 121 +== GetOpenInvoiceInformationByCustomerNo == 122 + 123 +Gets open invoices 124 + 125 +**Class diagram** 126 + 127 +**[[image:5-class-diagram-external.png]]** 128 + 129 +**Request parameters** 130 + 131 +(% class="table-bordered table-striped" %) 132 +|=(% colspan="4" %)((( 133 +==== GetOpenInvoiceInformationByCustomerNoRequest ==== 134 +))) 135 +|**Field**|**Datatype**|**Required**|**Description** 136 +|##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer. 137 +|##TrackingUserEMail##|String|No|User info for trackability. 138 +|##TraceId##|String|Yes| 139 + 140 +**Response parameters** 141 + 142 +(% class="table-bordered table-striped" %) 143 +|=(% colspan="3" %)((( 144 +==== GetOpenInvoiceInformationByCustomerNoResponse ==== 145 +))) 146 +|**Field**|**Datatype**|**Description** 147 +|##CompanyNo##|String| 148 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 149 +|##CustomerName##|String| 150 +|##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>| 151 +|##ResponseCode##|String| 152 +|##ResponseMessage##|String| 153 +|##TraceId##|String| 154 + 155 +**Classes** 156 + 157 +(% class="table-bordered table-striped" %) 158 +|=(% colspan="3" %)((( 159 +==== OpenInvoice ==== 160 +))) 161 +|**Field**|**Datatype**|**Description** 162 +|(% style="font-family:monospace" %)BillNo|String| 163 +|##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. 164 +|##ExternalInvoiceId##|String|Additional unique invoice identifier. 165 +|##BillDate##|DateTime| 166 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 167 +|##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. 168 +|##OriginalAmount##|Decimal| 169 +|##CurrentDebt##|Decimal| 170 +|##CurrencyCode##|String| 171 +|##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. 172 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 173 +|##PaymentType##|String| 174 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 175 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 176 + 177 +== GetClosedInvoiceInformationByCustomerNo == 178 + 179 +Gets closed invoices (status “Closed” only) 180 + 181 +**Class diagram** 182 + 183 +**[[image:6-class-diagram-external.png]]** 184 + 185 +**Request parameters** 186 + 187 +(% class="table-bordered table-striped" %) 188 +|=(% colspan="4" %)((( 189 +==== GetClosedInvoiceInformationCustomerNoRequest ==== 190 +))) 191 +|**Field**|**Datatype**|**Required**|**Description** 192 +|##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer. 193 +|##TrackingUserEMail##|String|No|User info for trackability. 194 +|##TraceId##|String|Yes| 195 + 196 +**Response parameters** 197 + 198 +(% class="table-bordered table-striped" %) 199 +|=(% colspan="3" %)((( 200 +==== GetClosedInvoiceInformationByCustomerNoResponse ==== 201 +))) 202 +|**Field**|**Datatype**|**Description** 203 +|##CompanyNo##|String|Yoyr accounts receivable number at PayEx. 204 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 205 +|##CustomerName##|String| 206 +|##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>| 207 +|##ResponseCode##|String| 208 +|##ResponseMessage##|String| 209 +|##TraceId##|String| 210 + 211 +**Classes** 212 + 213 +(% class="table-bordered table-striped" %) 214 +|=(% colspan="3" %)((( 215 +==== ClosedInvoice ==== 216 +))) 217 +|**Field**|**Datatype**|**Description** 218 +|(% style="font-family:monospace" %)BillNo|String| 219 +|##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. 220 +|##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable. 221 +|##BillDate##|DateTime| 222 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 223 +|##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. 224 +|##OriginalAmount##|Decimal| 225 +|##CurrencyCode##|String| 226 + 227 +== AddInvoiceRespiteByBillNo10 == 228 + 229 +Add respite date to an open invoice. 230 + 231 +**Class diagram** 232 +[[image:1573563792142-225.png||height="318" width="920"]] 233 +**Request parameters** 234 + 235 +(% class="table-bordered table-striped" %) 236 +|=(% colspan="4" %)((( 237 +==== AddInvoiceRespiteByBillNo10Request ==== 238 +))) 239 +|**Field**|**Datatype**|**Required**|**Description** 240 +|##BillNo##|String(15)|Yes|Bill Number. 241 +|##RespiteCause##|String(250)|Yes|Reason for respite. 242 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 243 +|##TraceId##|String|Yes| 244 +|##ValidToDate##|DateTime|Yes| 245 + 246 +**Response parameters** 247 + 248 +(% class="table-bordered table-striped" %) 249 +|=(% colspan="4" %)((( 250 +==== AddInvoiceRespiteByBillNo10Response ==== 251 +))) 252 +|**Field**|**Datatype**|**Description** 253 +|##ResponseCode##|String| 254 +|##ResponseMessage##|String| 255 +|##TraceId##|String| 256 + 257 +**Error codes** 258 + 259 +(% class="table-bordered table-striped" %) 260 +|=(% colspan="4" %)((( 261 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 262 +))) 263 +|**Code**|**Name**|**Description** 264 +|##5074##|InvalidDate|ValidToDate is not within a valid date. 265 +|##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType. 266 +|##1208##|InvalidAccountStatus|Respite not a valid action on this bill. 267 + 268 +== ConvertInvoiceToAccount10 == 269 + 270 +Convert an invoice account to a credit account. 271 + 272 +**Class diagram** 273 + 274 +[[image:1573569373687-299.png||height="324" width="739"]] 275 + 276 +**Request parameters** 277 + 278 +(% class="table-bordered table-striped" %) 279 +|=(% colspan="4" %)((( 280 +==== ConvertInvoiceToAccount10Request ==== 281 +))) 282 +|**Field**|**Datatype**|**Required**|**Description** 283 +|##BillNo##|String(15)|Yes|Bill Number. 284 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 285 +|##TraceId##|String|Yes| 286 + 287 +**Response parameters** 288 + 289 +(% class="table-bordered table-striped" %) 290 +|=(% colspan="4" %)((( 291 +==== ConvertInvoiceToAccount10Response ==== 292 +))) 293 +|**Field**|**Datatype**|**Description** 294 +|##ResponseCode##|String| 295 +|##ResponseMessage##|String| 296 +|##TraceId##|String| 297 + 298 +== DeletePaymentOrder == 299 + 300 +Abort a PaymentOrder for billNo 301 + 302 +**Class diagram** 303 + 304 +[[image:PxR_InvoiceService_DeletePaymentOrder.png||height="174" width="1267"]] 305 + 306 + 307 +**Request parameters** 308 + 309 +(% class="table-bordered table-striped" %) 310 +|=(% colspan="4" %)((( 311 +==== DeletePaymentOrderRequest ==== 312 +))) 313 +|**Field**|**Datatype**|**Required**|**Description** 314 +|##BillNo##|String|Yes|Bill to match paymentorder. 315 +|CompanyNo|String |Yes|Company number 316 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 317 +|TraceId|String|Yes| 318 + 319 +**Response parameters** 320 + 321 +(% class="table-bordered table-striped" %) 322 +|=(% colspan="4" %)((( 323 +==== DeletePaymentOrderResponse ==== 324 +))) 325 +|**Field**|**Datatype**|**Description** 326 +|##ResponseCode##|String| 327 +|##ResponseMessage##|String| 328 +|##TraceId##|String| 329 + 330 +**Error codes** 331 + 332 +(% class="table-bordered table-striped" %) 333 +|=(% colspan="4" %)((( 334 +==== DeletePaymentOrderResponse ==== 335 +))) 336 +|**Code**|**Name**|**Description** 337 +|##5080##|InvalidBillNo|BillNo is invalid 338 +|##5115##|PaymentOrderNotFound|Found no paymentorders connected to bill 339 +|##5116##|DeletePaymentOrderNotAllowed|Found paymentOrder but are not allowed to Delete since the paymentorder has begun/finished processing 340 + 341 +== RegisterInvoiceDirectPaymentByBillNo10 == 342 + 343 +Register a direct payment on given invoice. 344 + 345 +**Class diagram** 346 + 347 +[[image:1573570140844-820.png||height="384" width="715"]] 348 + 349 +**Request parameters** 350 + 351 +(% class="table-bordered table-striped" %) 352 +|=(% colspan="4" %)((( 353 +==== RegisterInvoiceDirectPaymentByBillNo10Request ==== 354 +))) 355 +|**Field**|**Datatype**|**Required**|**Description** 356 +|##Amount##|Decimal|Yes|DirectPayment Amount. 357 +|##BillNo##|String|Yes|Bill to match payment to. 358 +|##PaymentDate##|DateTime|Yes|Date when payment occured. 359 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 360 +|TraceId|String|Yes| 361 + 362 +**Response parameters** 363 + 364 +(% class="table-bordered table-striped" %) 365 +|=(% colspan="4" %)((( 366 +==== RegisterInvoiceDirectPaymentByBillNo10Response ==== 367 +))) 368 +|**Field**|**Datatype**|**Description** 369 +|##ResponseCode##|String| 370 +|##ResponseMessage##|String| 371 +|##TraceId##|String| 372 + 373 +**Error codes** 374 + 375 +(% class="table-bordered table-striped" %) 376 +|=(% colspan="4" %)((( 377 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 378 +))) 379 +|**Code**|**Name**|**Description** 380 +|##5080##|InvalidBillNo|BillNo is invalid 381 +|##1207##|InvalidAmount|Amount is invalid 382 +|##5074##|InvalidDate|PaymentDate is not within a valid date 383 + 384 +== AddInvoiceCopyOrderByBillNo10 == 385 + 386 +Order a copy of the invoice to be delivered. 387 + 388 +**Class diagram** 389 + 390 +[[image:1573631474317-399.png||height="349" width="795"]] 391 + 392 +**Request parameters** 393 + 394 +(% class="table-bordered table-striped" %) 395 +|=(% colspan="4" %)((( 396 +==== AddInvoiceCopyOrderByBillNo10Request ==== 397 +))) 398 +|**Field**|**Datatype**|**Required**|**Description** 399 +|##BillNo##|String|Yes| 400 +|##DistributionMethod##|String|Yes| 401 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 402 +|TraceId|String|Yes| 403 + 404 +**Response parameters** 405 + 406 +(% class="table-bordered table-striped" %) 407 +|=(% colspan="4" %)((( 408 +==== RegisterInvoiceDirectPaymentByBillNo10Response ==== 409 +))) 410 +|**Field**|**Datatype**|**Description** 411 +|##ResponseCode##|String| 412 +|##ResponseMessage##|String| 413 +|##TraceId##|String| 414 + 415 +**Error codes** 416 + 417 +(% class="table-bordered table-striped" %) 418 +|=(% colspan="4" %)((( 419 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 420 +))) 421 +|**Code**|**Name**|**Description** 422 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo 423 + 424 +== GetClosedInvoiceInformationByCustomerNo20 == 425 + 426 +Get information about a customer's closed invoice(s) by customer number. 427 + 428 +**Class diagram** 429 +[[image:1573632921277-742.png||height="509" width="841"]] 430 + 431 +**Request parameters** 432 + 433 +(% class="table-bordered table-striped" %) 434 +|=(% colspan="4" %)((( 435 +==== GetClosedInvoiceInformationByCustomerNo20Request ==== 436 +))) 437 +|**Field**|**Datatype**|**Required**|**Description** 438 +|##CustomerNo##|String|Yes| 439 +|##TrackingUserEmail##|String|Yes|User info for trackability. 440 +|TraceId| |yes| 441 + 442 +**Response parameters** 443 + 444 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 445 + 446 +== GetClosedInvoiceInformationByRegNo20 == 447 + 448 +Get information about a customer's closed invoice(s) by social security number. 449 + 450 +**Class diagram** 451 + 452 +[[image:1573646248641-666.png||height="508" width="807"]] 453 + 454 +**Request parameters** 455 + 456 +(% class="table-bordered table-striped" %) 457 +|=(% colspan="4" %)((( 458 +==== GetClosedInvoiceInformationByRegNo20Request ==== 459 +))) 460 +|**Field**|**Datatype**|**Required**|**Description** 461 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]] 462 +|##TrackingUserEmail##|String|Yes|User info for trackability. 463 +|TraceId| |yes| 464 + 465 +**Response parameters** 466 + 467 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 468 + 469 +**Error codes** 470 + 471 +(% class="table-bordered table-striped" %) 472 +|=(% colspan="4" %)((( 473 +==== GetClosedInvoiceInformation20Response ==== 474 +))) 475 +|**Code**|**Name**|**Description** 476 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead. 477 +|5075|MissingAccountForBill|Found no matching customer for RegNo. 478 +|1024|ErrorInvalidRegNo|Invalid RegNo format. 479 + 480 +== GetInvoiceInformationByBillNo20 == 481 + 482 +**Class diagram** 483 + 484 +[[image:1573648586121-179.png||height="582" width="1172"]] 485 + 486 +**Request parameters** 487 + 488 +(% class="table-bordered table-striped" %) 489 +|=(% colspan="4" %)((( 490 +==== GetInvoiceInformationByBillNo20Request ==== 491 +))) 492 +|**Field**|**Datatype**|**Required**|**Description** 493 +|##BillNo##|String|Yes| 494 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 495 +|TraceId|String|Yes| 496 + 497 +**Response parameters** 498 + 499 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]] 500 + 501 +**Error codes** 502 + 503 +(% class="table-bordered table-striped" %) 504 +|=(% colspan="4" %)((( 505 +==== GetInvoinceInformation20Response ==== 506 +))) 507 +|**Code**|**Name**|**Description** 508 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 509 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 510 + 511 +== GetInvoiceInformationByExternalInvoiceId20 == 512 + 513 +**Class diagram** 514 + 515 +[[image:1573822272252-854.png||height="581" width="1220"]] 516 + 517 +**Request parameters** 518 + 519 +(% class="table-bordered table-striped" %) 520 +|=(% colspan="4" %)((( 521 +==== GetInvoiceInformationByExternalInvoiceId20Request ==== 522 +))) 523 +|**Field**|**Datatype**|**Required**|**Description** 524 +|##ExternalInvoiceId##|String|Yes| 525 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 526 +|TraceId|String|Yes| 527 + 528 +**Response parameters** 529 + 530 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]] 531 + 532 +**Error codes** 533 + 534 +(% class="table-bordered table-striped" %) 535 +|=(% colspan="4" %)((( 536 +==== GetInvoinceInformation20Response ==== 537 +))) 538 +|**Code**|**Name**|**Description** 539 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 540 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 541 + 542 +== GetInvoicePdfByBillNoExternalBillType10 == 543 + 544 +**Class diagram** 545 + 546 +[[image:1573822789308-786.png||height="470" width="761"]] 547 + 548 +**Request parameters** 549 + 550 +(% class="table-bordered table-striped" %) 551 +|=(% colspan="4" %)((( 552 +==== GetInvoicePdfByBillNoExternalBillType10Request ==== 553 +))) 554 +|**Field**|**Datatype**|**Required**|**Description** 555 +|##BillNo##|String|Yes| 556 +|ExternalBillType|String|Yes|((( 557 +Document type. 558 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20. 559 +))) 560 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 561 +|TraceId|String|Yes| 562 + 563 +**Response parameters** 564 + 565 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]] 566 + 567 +**Error codes** 568 + 569 +(% class="table-bordered table-striped" %) 570 +|=(% colspan="4" %)((( 571 +==== GetInvoincePDFResponse ==== 572 +))) 573 +|**Code**|**Name**|**Description** 574 +|##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice. 575 +|5080|InvalidBillNo|Invoice document not found. 576 +|5095|ExternalBillTypeCode|Invalid ExternalBillType. 577 + 578 +== GetOpenInvoiceInformationByRegNo20 == 579 + 580 +**Class diagram** 581 + 582 +[[image:1573825242764-218.png||height="661" width="1066"]] 583 + 584 +**Request parameters** 585 + 586 +(% class="table-bordered table-striped" %) 587 +|=(% colspan="4" %)((( 588 +==== GetInvoicePdfByBillNoExternalBillType10Request ==== 589 +))) 590 +|**Field**|**Datatype**|**Required**|**Description** 591 +|RegNo|RegNo|Yes| 592 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 593 +|TraceId|String|Yes| 594 + 595 +**Response parameters** 596 + 597 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]] 598 + 599 +== RegisterInvoicePSPPaymentByBillNo10 == 600 + 601 +**Class diagram** 602 + 603 +[[image:1573825460421-413.png||height="460" width="778"]] 604 + 605 +**Request parameters** 606 + 607 +(% class="table-bordered table-striped" %) 608 +|=(% colspan="4" %)((( 609 +==== RegisterInvoicePSPPaymentByBillNoRequest ==== 610 +))) 611 +|**Field**|**Datatype**|**Required**|**Description** 612 +|##BillNo##|String|Yes| 613 +|Amount|Decimal|Yes| 614 +|PaymentDate|DateTime|Yes| 615 +|SellerTransactionId|String|Yes| 616 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 617 +|TraceId|String|Yes| 618 + 619 +**Response parameters** 620 + 621 +(% class="table-bordered table-striped" %) 622 +|=(% colspan="4" %)((( 623 +==== RegisterInvoicePSPPaymentByBillNoResponse ==== 624 +))) 625 +|**Field**|**Datatype**|**Description** 626 +|##ResponseCode##|String| 627 +|##ResponseMessage##|String| 628 +|TraceId|String| 629 + 630 += CreditAccount Service methods = 631 + 632 +The complete Wsdl specification for this service can be found at: [[https:/connect.payex.com~~/~~/PxR/CreditAccountService.svc?wsdl>>https://connect.payex.com/PxR/CreditAccountService.svc?wsdl]] 633 + 634 +(Username/password security model) 635 + 636 + 637 +== GetBillingAccountCurrentStateByBillingAccountNo10 == 638 + 639 +**Class diagram** 640 + 641 +[[image:1574423356546-688.png||height="954" width="923"]] 642 + 643 +**Request parameters** 644 + 645 +(% class="table-bordered table-striped" %) 646 +|=(% colspan="4" %)((( 647 +==== GetBillingAccountCurrentStateByBillingAccountNo10Request ==== 648 +))) 649 +|**Field**|**Datatype**|**Required**|**Description** 650 +|##BillingAccountNo##|String(15)|Yes| 651 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 652 +|TraceId|String|Yes| 653 + 654 +**Response parameters** 655 + 656 + 657 +(% class="table-bordered table-striped" %) 658 +|=(% colspan="3" %)((( 659 +==== GetBillingAccountCurrentStateByBillingAccountNo10Response ==== 660 +))) 661 +|**Field**|**Datatype**|**Description** 662 +|##CompanyNo##|String| 663 +|BillingAccount|[[BillingAccountDetail>>||anchor="HBillingAccountDetail"]]| 664 +|ResponseCode|String| 665 +|ResponseMessage|String| 666 +|TraceId|String| 667 + 668 +**Classes** 669 + 670 +(% class="table-bordered table-striped" %) 671 +|=(% colspan="3" %)((( 672 +==== BillingAccountDetail ==== 673 +))) 674 +|**Field**|**Datatype**|**Description** 675 +|##BillingAccountNo##|String| 676 +|BillingAccountAlias|String| 677 +|Description|String| 678 +|OpenBill|[[BillDetail>>||anchor="HBillDetail"]]| 679 +|PaymentBankAccount|[[PaymentBankAccount20>>||anchor="HPaymentBankAccount20inheritPaymentBankAccount"]]| 680 +|PaymentReference|String| 681 +|ClosedBillHistoryList|List<[[BillHistory>>||anchor="HBillHistory"]]>| 682 +|CreditAccountList|List<[[CreditAccount>>||anchor="HCreditAccount"]]>| 683 +|CurrentBillingAccountDebt|Decimal| 684 +|CurrentBillingAccountAndCreditAccountDebt|Decimal| 685 +|CurrencyCode|String| 686 +|StartDate|DateTime| 687 +|PenaltyInterest|[[Intrest>>||anchor="HIntrest"]]| 688 + 689 +(% class="table-bordered table-striped" %) 690 +|=(% colspan="3" %)((( 691 +==== CreditAccount ==== 692 +))) 693 +|**Field**|**Datatype**|**Description** 694 +|##CreditAccountNo##|String| 695 +|Description|String| 696 +|StartDate|DateTime| 697 +|CreditAccountAlias|String| 698 +|CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>| 699 +|AccountLimit|Decimal| 700 +|DebtInterest|[[Intrest>>||anchor="HIntrest"]]| 701 + 702 +**Error codes** 703 + 704 +(% class="table-bordered table-striped" %) 705 +|=(% colspan="3" %)((( 706 +==== GetBillingAccountCurrentStateByBillingAccountNo10Response ==== 707 +))) 708 +|**Code**|**Name**|**Description** 709 +|##5028##|MissingAccountForBillingAccount|Cant find BillingAccount in this company. 710 + 711 +== GetBillPdfByBillNoExternalBillType10 == 712 + 713 +**Class diagram** 714 + 715 +[[image:1574426401088-684.png||height="403" width="812"]] 716 + 717 +**Request parameters** 718 + 719 +(% class="table-bordered table-striped" %) 720 +|=(% colspan="4" %)((( 721 +==== GetBillPdfByBillNoExternalBillType10Request ==== 722 +))) 723 +|**Field**|**Datatype**|**Required**|**Description** 724 +|##BillNo##|String|Yes| 725 +|ExternalBillType|String|Yes| 726 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 727 +|TraceId|String|Yes| 728 + 729 +**Response parameters** 730 + 731 +[[GetInvoicePdfResponse>>||anchor="HGetInvoicePDFResponse"]] 732 + 733 +== GetClosedBillingAccountByRegNo10 == 734 + 735 +**Class diagram** 736 + 737 +[[image:1574426572366-122.png||height="369" width="884"]] 738 + 739 +**Request parameters** 740 + 741 +(% class="table-bordered table-striped" %) 742 +|=(% colspan="4" %)((( 743 +==== GetClosedBillingAccountByRegNo10Request ==== 744 +))) 745 +|**Field**|**Datatype**|**Required**|**Description** 746 +|##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes| 747 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 748 +|TraceId|String|Yes| 749 + 750 +**Response parameters** 751 + 752 +(% class="table-bordered table-striped" %) 753 +|=(% colspan="3" %)((( 754 +==== GetClosedBillingAccountByRegNo10Response ==== 755 +))) 756 +|**Field**|**Datatype**|**Description** 757 +|##CompanyNo##|String| 758 +|RegNo|[[RegNo>>||anchor="HRegNo"]]| 759 +|BillingAccountList|List<[[ClosedBillingAccountInfo>>||anchor="HClosedBillingAccountInfo"]]>| 760 +|ResponseCode|String| 761 +|ResponseMessage|String| 762 +|TraceId|String| 763 + 764 +**Classes** 765 + 766 +(% class="table-bordered table-striped" %) 767 +|=(% colspan="3" %)((( 768 +==== ClosedBillingAccountInfo ==== 769 +))) 770 +|**Field**|**Datatype**|**Description** 771 +|##BillingAccountNo##|String| 772 +|BillingAccountAlias|String| 773 +|Description|String| 774 + 775 +== GetOpenBillingAccountByRegNo10 == 776 + 777 +**Class diagram** 778 + 779 +[[image:1574427881741-366.png||height="851" width="1171"]] 780 + 781 +**Request parameters** 782 + 783 +(% class="table-bordered table-striped" %) 784 +|=(% colspan="4" %)((( 785 +==== GetOpenBillingAccountByRegNo10Request ==== 786 +))) 787 +|**Field**|**Datatype**|**Required**|**Description** 788 +|##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes| 789 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 790 +|TraceId|String|Yes| 791 + 792 +**Response parameters** 793 + 794 +(% class="table-bordered table-striped" %) 795 +|=(% colspan="3" %)((( 796 +==== GetOpenBillingAccountByRegNo10Response ==== 797 +))) 798 +|**Field**|**Datatype**|**Description** 799 +|##CompanyNo##|String| 800 +|RegNo|[[RegNo>>||anchor="HRegNo"]]| 801 +|BillingAccountList|List<[[OpenBillingAccountInfo>>||anchor="HOpenBillingAccountInfo"]]>| 802 +|ResponseCode|String| 803 +|ResponseMessage|String| 804 +|TraceId|String| 805 + 806 +**Classes** 807 + 808 +(% class="table-bordered table-striped" %) 809 +|=(% colspan="3" %)((( 810 +==== OpenBillingAccountInfo ==== 811 +))) 812 +|**Field**|**Datatype**|**Description** 813 +|##BillingAccountNo##|String| 814 +|BillingAccountAlias|String| 815 +|Description|String| 816 +|OpenBill|[[BillDetail>>||anchor="HBillDetail"]]| 817 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]| 818 +|CurrentBillingAccountDebt|decimal| 819 +|PaymentReference|string| 820 + 821 +== RegisterBillPSPPaymentBillingAccountNo10 == 822 + 823 +**Class diagram** 824 + 825 +[[image:1574428685798-189.png||height="460" width="778"]] 826 + 827 +**Request parameters** 828 + 829 +(% class="table-bordered table-striped" %) 830 +|=(% colspan="4" %)((( 831 +==== RegisterBillPSPPaymentBillingAccountNo10Request ==== 832 +))) 833 +|**Field**|**Datatype**|**Required**|**Description** 834 +|##BillingAccountNo##|(% style="font-family:monospace" %)string(15)|Yes| 835 +|Amount|Decimal|Yes| 836 +|PaymentDate|DateTime|Yes| 837 +|SellerTransactionId|String|Yes| 838 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 839 +|TraceId|String|Yes| 840 + 841 +**Response parameters** 842 + 843 +(% class="table-bordered table-striped" %) 844 +|=(% colspan="3" %)((( 845 +==== RegisterBillPSPPaymentBillingAccountNo10Response ==== 846 +))) 847 +|**Field**|**Datatype**|**Description** 848 +|##ResponseCode##|String| 849 +|ResponseMessage|String| 850 +|TraceId|String| 851 + 852 +== RegisterBillDirectPaymentByBillingAccountNo10 == 853 + 854 +**Class diagram** 855 + 856 +[[image:1574431509616-621.png||height="360" width="883"]] 857 + 858 +**Request parameters** 859 + 860 +(% class="table-bordered table-striped" style="border:undefined" %) 861 +|=(% colspan="4" %)((( 862 +==== RegisterBillDirectPaymentByBillingAccountNo10Request ==== 863 +))) 864 +|**Field**|**Datatype**|**Required**|**Description** 865 +|##Amount##|Decimal|Yes| 866 +|BillingAccountNo|String(15)|Yes| 867 +|PaymentDate|DateTime|Yes| 868 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 869 +|TraceId|String|Yes| 870 + 871 +**Response parameters** 872 + 873 +(% class="table-bordered table-striped" %) 874 +|=(% colspan="3" %)((( 875 +==== RegisterBillDirectPaymentByBillingAccountNo10Request ==== 876 +))) 877 +|**Field**|**Datatype**|**Description** 878 +|##ResponseCode##|String| 879 +|ResponseMessage|String| 880 +|TraceId|String| 881 + 882 += CustomerService methods = 883 + 884 +The complete Wsdl specification for this service can be found at: 885 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]] 886 + 887 + (Username/password security model) 888 + 889 +== GetcustomerCurrentStateByCustomerNo == 890 + 891 +Get information about current state of a customer. 892 + 893 +**Class diagram** 894 + 895 +[[image:7-class-diagram-external.png]] 896 + 897 +**Request parameters** 898 + 899 +(% class="table-bordered table-striped" %) 900 +|=(% colspan="4" %)((( 901 +==== GetCustomerCurrentStateByCustomerNoRequest ==== 902 +))) 903 +|**Field**|**Datatype**|**Required**|**Description** 904 +|##CustomerNumber##|String(15)|Yes| 905 +|##TrackingUserEMail##|String|No| 906 + 907 +**Response parameters** 908 + 909 +(% class="table-bordered table-striped" %) 910 +|=(% colspan="3" %)((( 911 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 912 +))) 913 +|**Field**|**Datatype**|**Description** 914 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. 915 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| 916 +|##CustomerNo##|String| 917 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. 918 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 919 + 920 +**Classes** 921 + 922 +(% class="table-bordered table-striped" %) 923 +|=(% colspan="3" %)((( 924 +==== CustomerConsent ==== 925 +))) 926 +|**Field**|**Datatype**|**Description** 927 +|(% 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. 928 + 929 +(% class="table-bordered table-striped" %) 930 +|=(% colspan="3" %)((( 931 +==== CustomerInfo ==== 932 +))) 933 +|**Field**|**Datatype**|**Description** 934 +|(% style="font-family:monospace" %)##Name##|String| 935 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]| 936 +|##Language##|String| 937 +|##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. 938 +|##VatNo##|String| 939 +|##Category##| | 940 + 941 +(% class="table-bordered table-striped" %) 942 +|=(% colspan="3" %)((( 943 +==== CustomerStatus ==== 944 +))) 945 +|**Field**|**Datatype**|**Description** 946 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]] 947 + 948 +(% class="table-bordered table-striped" %) 949 +|=(% colspan="4" %)((( 950 +==== DistributionAddressInfo ==== 951 +))) 952 +|**Field**|**Datatype**|**Required**|**Description** 953 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]]. 954 +|##EMailAddress##|String|No| 955 +|##Cellphone##|String|No| 956 + 957 +(% class="table-bordered table-striped" %) 958 +|=(% colspan="4" %)((( 959 +==== Address ==== 960 +))) 961 +|**Field**|**Datatype**|**Required**|**Description** 962 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes| 963 +|##StreetAdress##|String(35)|No| 964 +|##ZipCode##|String(9)|Yes| 965 +|##City##|String(27)|Yes| 966 +|##CoAddress##|String(35)|No| 967 +|##CountryCode##|String(2)|Yes| 968 + 969 +== GetCustomerCurrentStateByRegNo10 == 970 + 971 +**Class diagram** 972 + 973 +[[image:1574422177227-663.png||height="671" width="1146"]] 974 + 975 +**Request parameters** 976 + 977 +(% class="table-bordered table-striped" %) 978 +|=(% colspan="4" %)((( 979 +==== GetCustomerCurrentStateByRegNo10Request ==== 980 +))) 981 +|**Field**|**Datatype**|**Required**|**Description** 982 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes| 983 +|##TrackingUserEMail##|String|Yes| 984 +|TraceId|String|Yes| 985 + 986 +**Response parameters** 987 + 988 +(% class="table-bordered table-striped" %) 989 +|=(% colspan="3" %)((( 990 +==== GetCustomerCurrentStateByRegNo10Response ==== 991 +))) 992 +|**Field**|**Datatype**|**Description** 993 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. 994 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| 995 +|##CustomerNo##|String| 996 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. 997 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 998 + 999 +(% id="HAppendix1SharedClasses" %) 1000 += Appendix 1 Shared Classes = 1001 + 1002 + 1003 +**Response parameters** 1004 + 1005 +(% class="table-bordered table-striped" %) 1006 +|=(% colspan="3" %)((( 1007 +==== GetInvoicePDFResponse ==== 1008 +))) 1009 +|**Field**|**Datatype**|**Description** 1010 +|##Pdf##|Byte[]| 1011 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 1012 +|##CustomerNo##|String| 1013 +|##ResponseCode##|String| 1014 +|##ResponseMessage##|String| 1015 +|##TraceId##|String| 1016 + 1017 +(% class="table-bordered table-striped" %) 1018 +|=(% colspan="3" %)((( 1019 +==== GetInvoiceInformationResponse ==== 1020 +))) 1021 +|**Field**|**Datatype**|**Description** 1022 +|##CompanyNo##|String| 1023 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 1024 +|##CustomerNo##|String| 1025 +|##CustomerName##|String| 1026 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]| 1027 +|##ResponseCode##|String| 1028 +|##ResponseMessage##|String| 1029 +|##TraceId##|String| 1030 + 1031 +(% class="table-bordered table-striped" %) 1032 +|=(% colspan="3" %)((( 1033 +==== RegNo ==== 1034 +))) 1035 +|**Field**|**Datatype**|**Description** 1036 +|##CountryCode##|String| 1037 +|##Value##|String| 1038 + 1039 +(% class="table-bordered table-striped" %) 1040 +|=(% colspan="3" %)((( 1041 +==== Invoice ==== 1042 +))) 1043 +|**Field**|**Datatype**|**Description** 1044 +|##PaymentReference##|String| 1045 +|##BillNo##|String| 1046 +|##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. 1047 +|##ExternalInvoiceId##|String| 1048 +|##ExternalReference##|String| 1049 +|##SellerNo##|String| 1050 +|##BillDate##|DateTime| 1051 +|##DueDate##|DateTime (Optional)| 1052 +|##OriginalAmount##|Decimal| 1053 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]| 1054 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>| 1055 +|##CurrencyCode##|String| 1056 +|##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. 1057 +|##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. 1058 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 1059 +|##PaymentType##|String| 1060 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 1061 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 1062 +|##BillId##|Long| 1063 +|##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. 1064 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>| 1065 + 1066 +(% class="table-bordered table-striped" %) 1067 +|=(% colspan="3" %)((( 1068 +==== Interest ==== 1069 +))) 1070 +|**Field**|**Datatype**|**Description** 1071 +|##CurrentInterestRate##|decimal| 1072 +|##InterestIntervalCode##|byte| 1073 + 1074 +(% class="table-bordered table-striped" %) 1075 +|=(% colspan="3" %)((( 1076 +==== Balance ==== 1077 +))) 1078 +|**Field**|**Datatype**|**Description** 1079 +|##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. 1080 +|##Amount##|decimal| 1081 + 1082 +(% class="table-bordered table-striped" %) 1083 +|=(% colspan="3" %)((( 1084 +==== PaymentBankAccount20 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ==== 1085 +))) 1086 +|**Field**|**Datatype**|**Description** 1087 +|##PaymentTypeName##|String| 1088 + 1089 +(% class="table-bordered table-striped" %) 1090 +|=(% colspan="3" %)((( 1091 +==== PaymentBankAccount ==== 1092 +))) 1093 +|**Field**|**Datatype**|**Description** 1094 +|##BankAccountNo##|String| 1095 +|##BankAccountType##|String| 1096 +|##BIC##|String| 1097 +|##IBAN##|String| 1098 + 1099 +(% class="table-bordered table-striped" %) 1100 +|=(% colspan="3" %)((( 1101 +==== ActiveRespite ==== 1102 +))) 1103 +|**Field**|**Datatype**|**Description** 1104 +|##RespiteValidtoDate##|DateTime| 1105 +|##RespiteTypeCode##|int| 1106 + 1107 +(% class="table-bordered table-striped" %) 1108 +|=(% colspan="3" %)((( 1109 +==== ActivePaymentOrder ==== 1110 +))) 1111 +|**Field**|**Datatype**|**Description** 1112 +|##PaymentType##|String| 1113 +|##ExecutionDate##|DateTime| 1114 + 1115 +(% class="table-bordered table-striped" %) 1116 +|=(% colspan="3" %)((( 1117 +==== InvoiceHistory ==== 1118 +))) 1119 +|**Field**|**Datatype**|**Description** 1120 +|BillDate|DateTime| 1121 +|BillId|long| 1122 +|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. 1123 + 1124 +(% class="table-bordered table-striped" %) 1125 +|=(% colspan="3" %)((( 1126 +==== GetClosedInvoiceInformation20Response ==== 1127 +))) 1128 +|**Field**|**Datatype**|**Description** 1129 +|CompanyNo|String| 1130 +|CustomerNo|string| 1131 +|CustomerName|String| 1132 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] 1133 + 1134 +(% class="table-bordered table-striped" %) 1135 +|=(% colspan="3" %)((( 1136 +==== ClosedInvoice20 ==== 1137 +))) 1138 +|**Field**|**Datatype**|**Description** 1139 +|CurrencyCode|String| 1140 +|BillNo|string| 1141 +|BillStatusCode|Int| 1142 +|ExternalInvoiceId|String| 1143 +|BillDate|DateTime| 1144 +|DueDate|DateTime?| 1145 +|ExternalBillType|String| 1146 +|OriginalAmount|Decimal| 1147 +|SellerName|String| 1148 +|SellerNo|String| 1149 + 1150 +(% class="table-bordered table-striped" %) 1151 +|=(% colspan="3" %)((( 1152 +==== GetInvoiceInformation20Response ==== 1153 +))) 1154 +|**Field**|**Datatype**|**Description** 1155 +|CompanyNo|String| 1156 +|RegNo|[[RegNo>>||anchor="HRegNo"]]| 1157 +|CustomerNo|string| 1158 +|CustomerName|String| 1159 +|Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]| 1160 + 1161 +(% class="table-bordered table-striped" %) 1162 +|=(% colspan="3" %)((( 1163 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ==== 1164 +))) 1165 +|**Field**|**Datatype**|**Description** 1166 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]| 1167 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>| 1168 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>| 1169 + 1170 +(% class="table-bordered table-striped" %) 1171 +|=(% colspan="3" %)((( 1172 +==== InvoiceHistory20 ==== 1173 +))) 1174 +|**Field**|**Datatype**|**Description** 1175 +|BillDate|DateTime| 1176 +|ExternalBillType|String| 1177 +|BillAmount|Decimal?| 1178 + 1179 +(% class="table-bordered table-striped" %) 1180 +|=(% colspan="3" %)((( 1181 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ==== 1182 +))) 1183 +|**Field**|**Datatype**|**Description** 1184 +|CurrentDebt|Decimal| 1185 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]| 1186 +|PaymentType|String| 1187 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| 1188 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| 1189 +|PaymentRefrence|String| 1190 +|ExportedToCollection|Bool| 1191 + 1192 +(% class="table-bordered table-striped" %) 1193 +|=(% colspan="3" %)((( 1194 +==== ActiveRespite20 ==== 1195 +))) 1196 +|**Field**|**Datatype**|**Description** 1197 +|RespiteValidToDate|DateTime?| 1198 +|RespiteTypeCode|Int| 1199 + 1200 +(% class="table-bordered table-striped" %) 1201 +|=(% colspan="3" %)((( 1202 +==== BillDetail ==== 1203 +))) 1204 +|**Field**|**Datatype**|**Description** 1205 +|ExternalBillId|String| 1206 +|DueDate|DateTime| 1207 +|ExportedToCollection|Bool| 1208 +|BillNo|String| 1209 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| 1210 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| 1211 +|CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>| 1212 +|BillHistoryList|List<[[BillHistory>>||anchor="HBillHistory"]]>| 1213 + 1214 +(% class="table-bordered table-striped" %) 1215 +|=(% colspan="3" %)((( 1216 +==== BillHistory ==== 1217 +))) 1218 +|**Field**|**Datatype**|**Description** 1219 +|BillDate|DateTime| 1220 +|ExternalBillType|String| 1221 +|BillAmount|Decimal| 1222 + 1223 += Appendix 2 Code specification = 1224 + 1225 +(% class="table-bordered table-striped" %) 1226 +|=(% colspan="2" %)((( 1227 +==== Bill status codes ==== 1228 +))) 1229 +|**BillStatusCodes**|**Description** 1230 +|1|Open 1231 +|2|Closed 1232 +|3|Closed_Diff 1233 +|4|Closed_Loss 1234 +|5|Reversed 1235 +|6|Arrears 1236 +|7|Closed_Rest 1237 +|8|Closed_Convert 1238 +|9|Closed_Sold 1239 +|10|Closed_Reversal 1240 +|11|Pending 1241 + 1242 +(% class="table-bordered table-striped" %) 1243 +|=(% colspan="2" %)((( 1244 +==== Claim level codes ==== 1245 +))) 1246 +|**ClaimLevelCode**|**Description** 1247 +|1|Invoice 1248 +|2|RestReminderSent 1249 +|3|ReminderSent 1250 +|4|RestReminderSent 1251 +|5|SecondReminderSent 1252 +|6|RestReminderSent 1253 +|7|CollectionClaimSent 1254 +|8|RestReminderSent 1255 +|9*|DebtCollection* 1256 +|10|Late Fee, credit account 1257 +|11|TerminationNoticeSent, credit account 1258 + 1259 +*Additional fees and interest may have occured in collection system, but is not included in the response. 1260 + 1261 +(% class="table-bordered table-striped" %) 1262 +|=(% colspan="2" %)((( 1263 +==== Bill type codes ==== 1264 +))) 1265 +|**BillTypeCode**|**Description** 1266 +|1|Invoice 1267 +|4|CreditInvoice 1268 + 1269 +(% class="table-bordered table-striped" %) 1270 +|=(% colspan="2" %)((( 1271 +==== Consent type codes ==== 1272 +))) 1273 +|**ConsentTypeCode**|**Description** 1274 +|1|BGAGSE 1275 +|2|EInvoiceB2CSE 1276 +|3|EInvoiceB2CNO 1277 +|4|BKAGNO 1278 +|5|KivraSE 1279 +|6|EInvoiceB2CFI 1280 + 1281 +(% class="table-bordered table-striped" %) 1282 +|=(% colspan="2" %)((( 1283 +==== CustomerStatus type codes ==== 1284 +))) 1285 +|**CustomerStatusTypeCode**|**Description** 1286 +|1|ConfirmedDeceased 1287 +|2|ConfirmedBankruptcy 1288 +|3|ActiveComplaints 1289 + 1290 +(% class="table-bordered table-striped" %) 1291 +|=(% colspan="2" %)((( 1292 +==== Legal entity codes ==== 1293 +))) 1294 +|**LegalEntiytCode**|**Description** 1295 +|None|None 1296 +|Private|Private 1297 +|Business|Business 1298 + 1299 +(% class="table-bordered table-striped" %) 1300 +|=(% colspan="2" %)((( 1301 +==== Balance type codes ==== 1302 +))) 1303 +|**BalanceTypeCode**|**Description** 1304 +|0|None 1305 +|1|Capital 1306 +|2|ReminderFee 1307 +|3|PenaltyInterest 1308 +|4|CalculatedPenaltyInterest 1309 +|5|CollectionFee 1310 +|6|BusinessReminderFee 1311 +|7|BillingFee 1312 +|8|DelayFee 1313 +|9|DebtInterest 1314 +|10|DebtCollectionCharge 1315 +|11|Rounding 1316 + 1317 +(% class="table-bordered table-striped" %) 1318 +|=(% colspan="2" %)((( 1319 +==== Collection status codes ==== 1320 +))) 1321 +|**CollectionStatusCode**|**Description** 1322 +|1|PreDebtCollection 1323 +|2|DebtCollection 1324 +|3|LegalProcess 1325 +|4|Monitoring 1326 +|5|External 1327 +|6|Closed 1328 +|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
- 1573648586121-179.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573822272252-854.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573822789308-786.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573825242764-218.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573825460421-413.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574422177227-663.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574423356546-688.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574426401088-684.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574426572366-122.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574427881741-366.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574428685798-189.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574431509616-621.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
- PxR_InvoiceService_DeletePaymentOrder.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.avp - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content