Wiki source code of ExternalServices manual
Last modified by frn on 2021/06/29 16:53
| 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 | = CreditAccount Service methods = |
| 13 | |
| 14 | 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]] |
| 15 | |
| 16 | (Username/password security model) |
| 17 | |
| 18 | |
| 19 | == GetBillingAccountCurrentStateByBillingAccountNo11 == |
| 20 | |
| 21 | **Class diagram** |
| 22 | |
| 23 | [[image:1574423356546-688.png||height="954" width="923"]] |
| 24 | |
| 25 | **Request parameters** |
| 26 | |
| 27 | (% class="table-bordered table-striped" %) |
| 28 | |=(% colspan="4" %)((( |
| 29 | ==== GetBillingAccountCurrentStateByBillingAccountNo11Request ==== |
| 30 | ))) |
| 31 | |**Field**|**Datatype**|**Required**|**Description** |
| 32 | |##BillingAccountNo##|String(15)|Yes| |
| 33 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 34 | |TraceId|String|Yes| |
| 35 | |
| 36 | **Response parameters** |
| 37 | |
| 38 | |
| 39 | (% class="table-bordered table-striped" %) |
| 40 | |=(% colspan="3" %)((( |
| 41 | ==== GetBillingAccountCurrentStateByBillingAccountNo11Response ==== |
| 42 | ))) |
| 43 | |**Field**|**Datatype**|**Description** |
| 44 | |##CompanyNo##|String| |
| 45 | |BillingAccount|[[BillingAccountDetail11>>||anchor="HBillingAccountDetail"]]| |
| 46 | |ResponseCode|String| |
| 47 | |ResponseMessage|String| |
| 48 | |TraceId|String| |
| 49 | |
| 50 | **Classes** |
| 51 | |
| 52 | (% class="table-bordered table-striped" %) |
| 53 | |=(% colspan="3" %)((( |
| 54 | ==== BillingAccountDetail11 ==== |
| 55 | ))) |
| 56 | |**Field**|**Datatype**|**Description** |
| 57 | |##BillingAccountNo##|String| |
| 58 | |BillingAccountAlias|String| |
| 59 | |Description|String| |
| 60 | |OpenBill|[[BillDetail>>||anchor="HBillDetail"]]| |
| 61 | |PaymentBankAccount|[[PaymentBankAccount20>>||anchor="HPaymentBankAccount20inheritPaymentBankAccount"]]| |
| 62 | |PaymentReference|String| |
| 63 | |ClosedBillHistoryList|List<[[BillHistory11>>doc:||anchor="HBillHistory11"]]>| |
| 64 | |CreditAccountList|List<[[CreditAccount>>||anchor="HCreditAccount"]]>| |
| 65 | |CurrentBillingAccountDebt|Decimal| |
| 66 | |CurrentBillingAccountAndCreditAccountDebt|Decimal| |
| 67 | |CurrencyCode|String| |
| 68 | |StartDate|DateTime| |
| 69 | |PenaltyInterest|[[Intrest>>||anchor="HIntrest"]]| |
| 70 | |
| 71 | (% class="table-bordered table-striped" %) |
| 72 | |=(% colspan="3" %)((( |
| 73 | ==== CreditAccount ==== |
| 74 | ))) |
| 75 | |**Field**|**Datatype**|**Description** |
| 76 | |##CreditAccountNo##|String| |
| 77 | |Description|String| |
| 78 | |StartDate|DateTime| |
| 79 | |CreditAccountAlias|String| |
| 80 | |CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>| |
| 81 | |AccountLimit|Decimal| |
| 82 | |DebtInterest|[[Intrest>>||anchor="HIntrest"]]| |
| 83 | |
| 84 | **Error codes** |
| 85 | |
| 86 | (% class="table-bordered table-striped" %) |
| 87 | |=(% colspan="3" %)((( |
| 88 | ==== GetBillingAccountCurrentStateByBillingAccountNo10Response ==== |
| 89 | ))) |
| 90 | |**Code**|**Name**|**Description** |
| 91 | |##5028##|MissingAccountForBillingAccount|Cant find BillingAccount in this company. |
| 92 | |
| 93 | == GetBillPdfByBillNoExternalBillType10 == |
| 94 | |
| 95 | **Class diagram** |
| 96 | |
| 97 | [[image:1574426401088-684.png||height="403" width="812"]] |
| 98 | |
| 99 | **Request parameters** |
| 100 | |
| 101 | (% class="table-bordered table-striped" %) |
| 102 | |=(% colspan="4" %)((( |
| 103 | ==== GetBillPdfByBillNoExternalBillType10Request ==== |
| 104 | ))) |
| 105 | |**Field**|**Datatype**|**Required**|**Description** |
| 106 | |##BillNo##|String|Yes| |
| 107 | |ExternalBillType|String|Yes| |
| 108 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 109 | |TraceId|String|Yes| |
| 110 | |
| 111 | **Response parameters** |
| 112 | |
| 113 | [[GetInvoicePdfResponse>>||anchor="HGetInvoicePDFResponse"]] |
| 114 | |
| 115 | == GetClosedBillingAccountByRegNo10 == |
| 116 | |
| 117 | **Class diagram** |
| 118 | |
| 119 | [[image:1574426572366-122.png||height="369" width="884"]] |
| 120 | |
| 121 | **Request parameters** |
| 122 | |
| 123 | (% class="table-bordered table-striped" %) |
| 124 | |=(% colspan="4" %)((( |
| 125 | ==== GetClosedBillingAccountByRegNo10Request ==== |
| 126 | ))) |
| 127 | |**Field**|**Datatype**|**Required**|**Description** |
| 128 | |##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes| |
| 129 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 130 | |TraceId|String|Yes| |
| 131 | |
| 132 | **Response parameters** |
| 133 | |
| 134 | (% class="table-bordered table-striped" %) |
| 135 | |=(% colspan="3" %)((( |
| 136 | ==== GetClosedBillingAccountByRegNo10Response ==== |
| 137 | ))) |
| 138 | |**Field**|**Datatype**|**Description** |
| 139 | |##CompanyNo##|String| |
| 140 | |RegNo|[[RegNo>>||anchor="HRegNo"]]| |
| 141 | |BillingAccountList|List<[[ClosedBillingAccountInfo>>||anchor="HClosedBillingAccountInfo"]]>| |
| 142 | |ResponseCode|String| |
| 143 | |ResponseMessage|String| |
| 144 | |TraceId|String| |
| 145 | |
| 146 | **Classes** |
| 147 | |
| 148 | (% class="table-bordered table-striped" %) |
| 149 | |=(% colspan="3" %)((( |
| 150 | ==== ClosedBillingAccountInfo ==== |
| 151 | ))) |
| 152 | |**Field**|**Datatype**|**Description** |
| 153 | |##BillingAccountNo##|String| |
| 154 | |BillingAccountAlias|String| |
| 155 | |Description|String| |
| 156 | |
| 157 | == GetOpenBillingAccountByRegNo10 == |
| 158 | |
| 159 | **Class diagram** |
| 160 | |
| 161 | [[image:1574427881741-366.png||height="851" width="1171"]] |
| 162 | |
| 163 | **Request parameters** |
| 164 | |
| 165 | (% class="table-bordered table-striped" %) |
| 166 | |=(% colspan="4" %)((( |
| 167 | ==== GetOpenBillingAccountByRegNo10Request ==== |
| 168 | ))) |
| 169 | |**Field**|**Datatype**|**Required**|**Description** |
| 170 | |##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes| |
| 171 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 172 | |TraceId|String|Yes| |
| 173 | |
| 174 | **Response parameters** |
| 175 | |
| 176 | (% class="table-bordered table-striped" %) |
| 177 | |=(% colspan="3" %)((( |
| 178 | ==== GetOpenBillingAccountByRegNo10Response ==== |
| 179 | ))) |
| 180 | |**Field**|**Datatype**|**Description** |
| 181 | |##CompanyNo##|String| |
| 182 | |RegNo|[[RegNo>>||anchor="HRegNo"]]| |
| 183 | |BillingAccountList|List<[[OpenBillingAccountInfo>>||anchor="HOpenBillingAccountInfo"]]>| |
| 184 | |ResponseCode|String| |
| 185 | |ResponseMessage|String| |
| 186 | |TraceId|String| |
| 187 | |
| 188 | **Classes** |
| 189 | |
| 190 | (% class="table-bordered table-striped" %) |
| 191 | |=(% colspan="3" %)((( |
| 192 | ==== OpenBillingAccountInfo ==== |
| 193 | ))) |
| 194 | |**Field**|**Datatype**|**Description** |
| 195 | |##BillingAccountNo##|String| |
| 196 | |BillingAccountAlias|String| |
| 197 | |Description|String| |
| 198 | |OpenBill|[[BillDetail>>||anchor="HBillDetail"]]| |
| 199 | |PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]| |
| 200 | |CurrentBillingAccountDebt|decimal| |
| 201 | |PaymentReference|string| |
| 202 | |
| 203 | == RegisterBillPSPPaymentBillingAccountNo10 == |
| 204 | |
| 205 | **Class diagram** |
| 206 | |
| 207 | [[image:1574428685798-189.png||height="460" width="778"]] |
| 208 | |
| 209 | **Request parameters** |
| 210 | |
| 211 | (% class="table-bordered table-striped" %) |
| 212 | |=(% colspan="4" %)((( |
| 213 | ==== RegisterBillPSPPaymentBillingAccountNo10Request ==== |
| 214 | ))) |
| 215 | |**Field**|**Datatype**|**Required**|**Description** |
| 216 | |##BillingAccountNo##|(% style="font-family:monospace" %)string(15)|Yes| |
| 217 | |Amount|Decimal|Yes| |
| 218 | |PaymentDate|DateTime|Yes| |
| 219 | |SellerTransactionId|String|Yes| |
| 220 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 221 | |TraceId|String|Yes| |
| 222 | |
| 223 | **Response parameters** |
| 224 | |
| 225 | (% class="table-bordered table-striped" %) |
| 226 | |=(% colspan="3" %)((( |
| 227 | ==== RegisterBillPSPPaymentBillingAccountNo10Response ==== |
| 228 | ))) |
| 229 | |**Field**|**Datatype**|**Description** |
| 230 | |##ResponseCode##|String| |
| 231 | |ResponseMessage|String| |
| 232 | |TraceId|String| |
| 233 | |
| 234 | == RegisterBillDirectPaymentByBillingAccountNo10 == |
| 235 | |
| 236 | **Class diagram** |
| 237 | |
| 238 | [[image:1574431509616-621.png||height="360" width="883"]] |
| 239 | |
| 240 | **Request parameters** |
| 241 | |
| 242 | (% class="table-bordered table-striped" style="border:undefined" %) |
| 243 | |=(% colspan="4" %)((( |
| 244 | ==== RegisterBillDirectPaymentByBillingAccountNo10Request ==== |
| 245 | ))) |
| 246 | |**Field**|**Datatype**|**Required**|**Description** |
| 247 | |##Amount##|Decimal|Yes| |
| 248 | |BillingAccountNo|String(15)|Yes| |
| 249 | |PaymentDate|DateTime|Yes| |
| 250 | |TrackingUserEMail|String(1-256)|Yes|User info for trackability. |
| 251 | |TraceId|String|Yes| |
| 252 | |
| 253 | **Response parameters** |
| 254 | |
| 255 | (% class="table-bordered table-striped" %) |
| 256 | |=(% colspan="3" %)((( |
| 257 | ==== RegisterBillDirectPaymentByBillingAccountNo10Request ==== |
| 258 | ))) |
| 259 | |**Field**|**Datatype**|**Description** |
| 260 | |##ResponseCode##|String| |
| 261 | |ResponseMessage|String| |
| 262 | |TraceId|String| |
| 263 | |
| 264 | = CustomerService methods = |
| 265 | |
| 266 | The complete Wsdl specification for this service can be found at: |
| 267 | [[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]] |
| 268 | |
| 269 | (Username/password security model) |
| 270 | |
| 271 | == GetcustomerCurrentStateByCustomerNo == |
| 272 | |
| 273 | Get information about current state of a customer. |
| 274 | |
| 275 | **Class diagram** |
| 276 | |
| 277 | [[image:7-class-diagram-external.png]] |
| 278 | |
| 279 | **Request parameters** |
| 280 | |
| 281 | (% class="table-bordered table-striped" %) |
| 282 | |=(% colspan="4" %)((( |
| 283 | ==== GetCustomerCurrentStateByCustomerNoRequest ==== |
| 284 | ))) |
| 285 | |**Field**|**Datatype**|**Required**|**Description** |
| 286 | |##CustomerNumber##|String(15)|Yes| |
| 287 | |##TrackingUserEMail##|String|No| |
| 288 | |
| 289 | **Response parameters** |
| 290 | |
| 291 | (% class="table-bordered table-striped" %) |
| 292 | |=(% colspan="3" %)((( |
| 293 | ==== GetCustomerCurrentStateByCustomerNoResponse ==== |
| 294 | ))) |
| 295 | |**Field**|**Datatype**|**Description** |
| 296 | |(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. |
| 297 | |##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| |
| 298 | |##CustomerNo##|String| |
| 299 | |##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. |
| 300 | |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| |
| 301 | |
| 302 | **Classes** |
| 303 | |
| 304 | (% class="table-bordered table-striped" %) |
| 305 | |=(% colspan="3" %)((( |
| 306 | ==== CustomerConsent ==== |
| 307 | ))) |
| 308 | |**Field**|**Datatype**|**Description** |
| 309 | |(% style="font-family:monospace" %)##ConsentTypeCode##|Int|See the [[consent type codes>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HConsenttypecodes"]] table for available consent type codes. |
| 310 | |
| 311 | (% class="table-bordered table-striped" %) |
| 312 | |=(% colspan="3" %)((( |
| 313 | ==== CustomerInfo ==== |
| 314 | ))) |
| 315 | |**Field**|**Datatype**|**Description** |
| 316 | |(% style="font-family:monospace" %)##Name##|String| |
| 317 | |##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]| |
| 318 | |##Language##|String| |
| 319 | |##LegalEntityCode##|Int|See the [[legal entity codes table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HLegalentitycodes"]] for available legal entity codes. |
| 320 | |##VatNo##|String| |
| 321 | |##Category##| | |
| 322 | |
| 323 | (% class="table-bordered table-striped" %) |
| 324 | |=(% colspan="3" %)((( |
| 325 | ==== CustomerStatus ==== |
| 326 | ))) |
| 327 | |**Field**|**Datatype**|**Description** |
| 328 | |(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]] |
| 329 | |
| 330 | (% class="table-bordered table-striped" %) |
| 331 | |=(% colspan="4" %)((( |
| 332 | ==== DistributionAddressInfo ==== |
| 333 | ))) |
| 334 | |**Field**|**Datatype**|**Required**|**Description** |
| 335 | |(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]]. |
| 336 | |##EMailAddress##|String|No| |
| 337 | |##Cellphone##|String|No| |
| 338 | |
| 339 | (% class="table-bordered table-striped" %) |
| 340 | |=(% colspan="4" %)((( |
| 341 | ==== Address ==== |
| 342 | ))) |
| 343 | |**Field**|**Datatype**|**Required**|**Description** |
| 344 | |(% style="font-family:monospace" %)Addressee|String(72)|Yes| |
| 345 | |##StreetAdress##|String(35)|No| |
| 346 | |##ZipCode##|String(9)|Yes| |
| 347 | |##City##|String(27)|Yes| |
| 348 | |##CoAddress##|String(35)|No| |
| 349 | |##CountryCode##|String(2)|Yes| |
| 350 | |
| 351 | == GetCustomerCurrentStateByRegNo10 == |
| 352 | |
| 353 | **Class diagram** |
| 354 | |
| 355 | [[image:1574422177227-663.png||height="671" width="1146"]] |
| 356 | |
| 357 | **Request parameters** |
| 358 | |
| 359 | (% class="table-bordered table-striped" %) |
| 360 | |=(% colspan="4" %)((( |
| 361 | ==== GetCustomerCurrentStateByRegNo10Request ==== |
| 362 | ))) |
| 363 | |**Field**|**Datatype**|**Required**|**Description** |
| 364 | |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes| |
| 365 | |##TrackingUserEMail##|String|Yes| |
| 366 | |TraceId|String|Yes| |
| 367 | |
| 368 | **Response parameters** |
| 369 | |
| 370 | (% class="table-bordered table-striped" %) |
| 371 | |=(% colspan="3" %)((( |
| 372 | ==== GetCustomerCurrentStateByRegNo10Response ==== |
| 373 | ))) |
| 374 | |**Field**|**Datatype**|**Description** |
| 375 | |(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. |
| 376 | |##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| |
| 377 | |##CustomerNo##|String| |
| 378 | |##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. |
| 379 | |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| |
| 380 | |
| 381 | (% id="HAppendix1SharedClasses" %) |
| 382 | = Appendix 1 Shared Classes = |
| 383 | |
| 384 | |
| 385 | **Response parameters** |
| 386 | |
| 387 | (% class="table-bordered table-striped" %) |
| 388 | |=(% colspan="3" %)((( |
| 389 | ==== GetInvoicePDFResponse ==== |
| 390 | ))) |
| 391 | |**Field**|**Datatype**|**Description** |
| 392 | |##Pdf##|Byte[]| |
| 393 | |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| |
| 394 | |##CustomerNo##|String| |
| 395 | |##ResponseCode##|String| |
| 396 | |##ResponseMessage##|String| |
| 397 | |##TraceId##|String| |
| 398 | |
| 399 | (% class="table-bordered table-striped" %) |
| 400 | |=(% colspan="3" %)((( |
| 401 | ==== GetInvoiceInformationResponse ==== |
| 402 | ))) |
| 403 | |**Field**|**Datatype**|**Description** |
| 404 | |##CompanyNo##|String| |
| 405 | |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| |
| 406 | |##CustomerNo##|String| |
| 407 | |##CustomerName##|String| |
| 408 | |##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]| |
| 409 | |##ResponseCode##|String| |
| 410 | |##ResponseMessage##|String| |
| 411 | |##TraceId##|String| |
| 412 | |
| 413 | (% class="table-bordered table-striped" %) |
| 414 | |=(% colspan="3" %)((( |
| 415 | ==== RegNo ==== |
| 416 | ))) |
| 417 | |**Field**|**Datatype**|**Description** |
| 418 | |##CountryCode##|String| |
| 419 | |##Value##|String| |
| 420 | |
| 421 | (% class="table-bordered table-striped" %) |
| 422 | |=(% colspan="3" %)((( |
| 423 | ==== Invoice ==== |
| 424 | ))) |
| 425 | |**Field**|**Datatype**|**Description** |
| 426 | |##PaymentReference##|String| |
| 427 | |##BillNo##|String| |
| 428 | |##BillStatusCode##|Int|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. |
| 429 | |##ExternalInvoiceId##|String| |
| 430 | |##ExternalReference##|String| |
| 431 | |##SellerNo##|String| |
| 432 | |##BillDate##|DateTime| |
| 433 | |##DueDate##|DateTime (Optional)| |
| 434 | |##OriginalAmount##|Decimal| |
| 435 | |##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]| |
| 436 | |##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>| |
| 437 | |##CurrencyCode##|String| |
| 438 | |##CurrentClaimLevelCode##|Int|See the [[claim level codes table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClaimlevelcodes"]] for available claim level codes. |
| 439 | |##CollectionStatusCode##|Int|See the [[collection status code table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCollectionstatuscodes"]] for available collection status codes. |
| 440 | |##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| |
| 441 | |##PaymentType##|String| |
| 442 | |##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| |
| 443 | |##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| |
| 444 | |##BillId##|Long| |
| 445 | |##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. |
| 446 | |##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>| |
| 447 | |
| 448 | (% class="table-bordered table-striped" %) |
| 449 | |=(% colspan="3" %)((( |
| 450 | ==== Interest ==== |
| 451 | ))) |
| 452 | |**Field**|**Datatype**|**Description** |
| 453 | |##CurrentInterestRate##|decimal| |
| 454 | |##InterestIntervalCode##|byte| |
| 455 | |
| 456 | (% class="table-bordered table-striped" %) |
| 457 | |=(% colspan="3" %)((( |
| 458 | ==== Balance ==== |
| 459 | ))) |
| 460 | |**Field**|**Datatype**|**Description** |
| 461 | |##BalanceTypeCode##|int|See the [[balance type codes table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalancetypecodes"]] for available balance type codes. |
| 462 | |##Amount##|decimal| |
| 463 | |
| 464 | (% class="table-bordered table-striped" %) |
| 465 | |=(% colspan="3" %)((( |
| 466 | ==== PaymentBankAccount20 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ==== |
| 467 | ))) |
| 468 | |**Field**|**Datatype**|**Description** |
| 469 | |##PaymentTypeName##|String| |
| 470 | |
| 471 | (% class="table-bordered table-striped" %) |
| 472 | |=(% colspan="3" %)((( |
| 473 | ==== PaymentBankAccount ==== |
| 474 | ))) |
| 475 | |**Field**|**Datatype**|**Description** |
| 476 | |##BankAccountNo##|String| |
| 477 | |##BankAccountType##|String| |
| 478 | |##BIC##|String| |
| 479 | |##IBAN##|String| |
| 480 | |
| 481 | (% class="table-bordered table-striped" %) |
| 482 | |=(% colspan="3" %)((( |
| 483 | ==== ActiveRespite ==== |
| 484 | ))) |
| 485 | |**Field**|**Datatype**|**Description** |
| 486 | |##RespiteValidtoDate##|DateTime| |
| 487 | |##RespiteTypeCode##|int| |
| 488 | |
| 489 | (% class="table-bordered table-striped" %) |
| 490 | |=(% colspan="3" %)((( |
| 491 | ==== ActivePaymentOrder ==== |
| 492 | ))) |
| 493 | |**Field**|**Datatype**|**Description** |
| 494 | |##PaymentType##|String| |
| 495 | |##ExecutionDate##|DateTime| |
| 496 | |
| 497 | (% class="table-bordered table-striped" %) |
| 498 | |=(% colspan="3" %)((( |
| 499 | ==== InvoiceHistory ==== |
| 500 | ))) |
| 501 | |**Field**|**Datatype**|**Description** |
| 502 | |BillDate|DateTime| |
| 503 | |BillId|long| |
| 504 | |BillTypeCode|byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. |
| 505 | |
| 506 | (% class="table-bordered table-striped" %) |
| 507 | |=(% colspan="3" %)((( |
| 508 | ==== GetClosedInvoiceInformation20Response ==== |
| 509 | ))) |
| 510 | |**Field**|**Datatype**|**Description** |
| 511 | |CompanyNo|String| |
| 512 | |CustomerNo|string| |
| 513 | |CustomerName|String| |
| 514 | |InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] |
| 515 | |
| 516 | (% class="table-bordered table-striped" %) |
| 517 | |=(% colspan="3" %)((( |
| 518 | ==== ClosedInvoice20 ==== |
| 519 | ))) |
| 520 | |**Field**|**Datatype**|**Description** |
| 521 | |CurrencyCode|String| |
| 522 | |BillNo|string| |
| 523 | |BillStatusCode|Int| |
| 524 | |ExternalInvoiceId|String| |
| 525 | |BillDate|DateTime| |
| 526 | |DueDate|DateTime?| |
| 527 | |ExternalBillType|String| |
| 528 | |OriginalAmount|Decimal| |
| 529 | |SellerName|String| |
| 530 | |SellerNo|String| |
| 531 | |
| 532 | (% class="table-bordered table-striped" %) |
| 533 | |=(% colspan="3" %)((( |
| 534 | ==== GetInvoiceInformation20Response ==== |
| 535 | ))) |
| 536 | |**Field**|**Datatype**|**Description** |
| 537 | |CompanyNo|String| |
| 538 | |RegNo|[[RegNo>>||anchor="HRegNo"]]| |
| 539 | |CustomerNo|string| |
| 540 | |CustomerName|String| |
| 541 | |Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]| |
| 542 | |
| 543 | (% class="table-bordered table-striped" %) |
| 544 | |=(% colspan="3" %)((( |
| 545 | ==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ==== |
| 546 | ))) |
| 547 | |**Field**|**Datatype**|**Description** |
| 548 | |PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]| |
| 549 | |CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>| |
| 550 | |InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>| |
| 551 | |
| 552 | (% class="table-bordered table-striped" %) |
| 553 | |=(% colspan="3" %)((( |
| 554 | ==== InvoiceHistory20 ==== |
| 555 | ))) |
| 556 | |**Field**|**Datatype**|**Description** |
| 557 | |BillDate|DateTime| |
| 558 | |ExternalBillType|String| |
| 559 | |BillAmount|Decimal?| |
| 560 | |
| 561 | (% class="table-bordered table-striped" %) |
| 562 | |=(% colspan="3" %)((( |
| 563 | ==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ==== |
| 564 | ))) |
| 565 | |**Field**|**Datatype**|**Description** |
| 566 | |CurrentDebt|Decimal| |
| 567 | |PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]| |
| 568 | |PaymentType|String| |
| 569 | |ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| |
| 570 | |ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| |
| 571 | |PaymentRefrence|String| |
| 572 | |ExportedToCollection|Bool| |
| 573 | |
| 574 | (% class="table-bordered table-striped" %) |
| 575 | |=(% colspan="3" %)((( |
| 576 | ==== ActiveRespite20 ==== |
| 577 | ))) |
| 578 | |**Field**|**Datatype**|**Description** |
| 579 | |RespiteValidToDate|DateTime?| |
| 580 | |RespiteTypeCode|Int| |
| 581 | |
| 582 | (% class="table-bordered table-striped" %) |
| 583 | |=(% colspan="3" %)((( |
| 584 | ==== BillDetail ==== |
| 585 | ))) |
| 586 | |**Field**|**Datatype**|**Description** |
| 587 | |ExternalBillId|String| |
| 588 | |DueDate|DateTime| |
| 589 | |ExportedToCollection|Bool| |
| 590 | |BillNo|String| |
| 591 | |ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| |
| 592 | |ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| |
| 593 | |CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>| |
| 594 | |BillHistoryList|List<[[BillHistory>>||anchor="HBillHistory"]]>| |
| 595 | |
| 596 | (% class="table-bordered table-striped" %) |
| 597 | |=(% colspan="3" %)((( |
| 598 | ==== BillHistory11 ==== |
| 599 | ))) |
| 600 | |**Field**|**Datatype**|**Description** |
| 601 | |BillDate|DateTime| |
| 602 | |ExternalBillType|String| |
| 603 | |BillAmount|Decimal| |
| 604 | |BillNo|String| |
| 605 | |
| 606 | = Appendix 2 Code specification = |
| 607 | |
| 608 | (% class="table-bordered table-striped" %) |
| 609 | |=(% colspan="2" %)((( |
| 610 | ==== Bill status codes ==== |
| 611 | ))) |
| 612 | |**BillStatusCodes**|**Description** |
| 613 | |1|Open |
| 614 | |2|Closed |
| 615 | |3|Closed_Diff |
| 616 | |4|Closed_Loss |
| 617 | |5|Reversed |
| 618 | |6|Arrears |
| 619 | |7|Closed_Rest |
| 620 | |8|Closed_Convert |
| 621 | |9|Closed_Sold |
| 622 | |10|Closed_Reversal |
| 623 | |11|Pending |
| 624 | |
| 625 | (% class="table-bordered table-striped" %) |
| 626 | |=(% colspan="2" %)((( |
| 627 | ==== Claim level codes ==== |
| 628 | ))) |
| 629 | |**ClaimLevelCode**|**Description** |
| 630 | |1|Invoice |
| 631 | |2|RestReminderSent |
| 632 | |3|ReminderSent |
| 633 | |4|RestReminderSent |
| 634 | |5|SecondReminderSent |
| 635 | |6|RestReminderSent |
| 636 | |7|CollectionClaimSent |
| 637 | |8|RestReminderSent |
| 638 | |9*|DebtCollection* |
| 639 | |10|Late Fee, credit account |
| 640 | |11|TerminationNoticeSent, credit account |
| 641 | |
| 642 | *Additional fees and interest may have occured in collection system, but is not included in the response. |
| 643 | |
| 644 | (% class="table-bordered table-striped" %) |
| 645 | |=(% colspan="2" %)((( |
| 646 | ==== Bill type codes ==== |
| 647 | ))) |
| 648 | |**BillTypeCode**|**Description** |
| 649 | |1|Invoice |
| 650 | |4|CreditInvoice |
| 651 | |
| 652 | (% class="table-bordered table-striped" %) |
| 653 | |=(% colspan="2" %)((( |
| 654 | ==== Consent type codes ==== |
| 655 | ))) |
| 656 | |**ConsentTypeCode**|**Description** |
| 657 | |1|BGAGSE |
| 658 | |2|EInvoiceB2CSE |
| 659 | |3|EInvoiceB2CNO |
| 660 | |4|BKAGNO |
| 661 | |5|KivraSE |
| 662 | |6|EInvoiceB2CFI |
| 663 | |
| 664 | (% class="table-bordered table-striped" %) |
| 665 | |=(% colspan="2" %)((( |
| 666 | ==== CustomerStatus type codes ==== |
| 667 | ))) |
| 668 | |**CustomerStatusTypeCode**|**Description** |
| 669 | |1|ConfirmedDeceased |
| 670 | |2|ConfirmedBankruptcy |
| 671 | |3|ActiveComplaints |
| 672 | |
| 673 | (% class="table-bordered table-striped" %) |
| 674 | |=(% colspan="2" %)((( |
| 675 | ==== Legal entity codes ==== |
| 676 | ))) |
| 677 | |**LegalEntiytCode**|**Description** |
| 678 | |None|None |
| 679 | |Private|Private |
| 680 | |Business|Business |
| 681 | |
| 682 | (% class="table-bordered table-striped" %) |
| 683 | |=(% colspan="2" %)((( |
| 684 | ==== Balance type codes ==== |
| 685 | ))) |
| 686 | |**BalanceTypeCode**|**Description** |
| 687 | |0|None |
| 688 | |1|Capital |
| 689 | |2|ReminderFee |
| 690 | |3|PenaltyInterest |
| 691 | |4|CalculatedPenaltyInterest |
| 692 | |5|CollectionFee |
| 693 | |6|BusinessReminderFee |
| 694 | |7|BillingFee |
| 695 | |8|DelayFee |
| 696 | |9|DebtInterest |
| 697 | |10|DebtCollectionCharge |
| 698 | |11|Rounding |
| 699 | |
| 700 | (% class="table-bordered table-striped" %) |
| 701 | |=(% colspan="2" %)((( |
| 702 | ==== Collection status codes ==== |
| 703 | ))) |
| 704 | |**CollectionStatusCode**|**Description** |
| 705 | |1|PreDebtCollection |
| 706 | |2|DebtCollection |
| 707 | |3|LegalProcess |
| 708 | |4|Monitoring |
| 709 | |5|External |
| 710 | |6|Closed |
| 711 | |7|ReturnedWrongAddress |