ExternalServices manual

The external services manual cover methods used to retrieve Invoice PDFs as well as invoice and customer information.

CreditAccount Service methods

The complete Wsdl specification for this service can be found at: https:/connect.payex.com//PxR/CreditAccountService.svc?wsdl

(Username/password security model)

GetBillingAccountCurrentStateByBillingAccountNo11

Class diagram

1574423356546-688.png

Request parameters

GetBillingAccountCurrentStateByBillingAccountNo11Request

FieldDatatypeRequiredDescription
BillingAccountNoString(15)Yes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetBillingAccountCurrentStateByBillingAccountNo11Response

FieldDatatypeDescription
CompanyNoString 
BillingAccountBillingAccountDetail11 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Classes

BillingAccountDetail11

FieldDatatypeDescription
BillingAccountNoString 
BillingAccountAliasString 
DescriptionString 
OpenBillBillDetail 
PaymentBankAccountPaymentBankAccount20 
PaymentReferenceString 
ClosedBillHistoryListList<BillHistory11> 
CreditAccountListList<CreditAccount> 
CurrentBillingAccountDebtDecimal 
CurrentBillingAccountAndCreditAccountDebtDecimal 
CurrencyCodeString 
StartDateDateTime 
PenaltyInterestIntrest 

CreditAccount

FieldDatatypeDescription
CreditAccountNoString 
DescriptionString 
StartDateDateTime 
CreditAccountAliasString 
CurrentBalanceListList<Balance> 
AccountLimitDecimal 
DebtInterestIntrest 

Error codes

GetBillingAccountCurrentStateByBillingAccountNo10Response

CodeNameDescription
5028MissingAccountForBillingAccountCant find BillingAccount in this company.

GetBillPdfByBillNoExternalBillType10

Class diagram

1574426401088-684.png

Request parameters

GetBillPdfByBillNoExternalBillType10Request

FieldDatatypeRequiredDescription
BillNoStringYes 
ExternalBillTypeStringYes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetInvoicePdfResponse

GetClosedBillingAccountByRegNo10

Class diagram

1574426572366-122.png

Request parameters

GetClosedBillingAccountByRegNo10Request

FieldDatatypeRequiredDescription
RegNoRegNoYes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetClosedBillingAccountByRegNo10Response

FieldDatatypeDescription
CompanyNoString 
RegNoRegNo 
BillingAccountListList<ClosedBillingAccountInfo> 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Classes

ClosedBillingAccountInfo

FieldDatatypeDescription
BillingAccountNoString 
BillingAccountAliasString 
DescriptionString 

GetOpenBillingAccountByRegNo10

Class diagram

1574427881741-366.png

Request parameters

GetOpenBillingAccountByRegNo10Request

FieldDatatypeRequiredDescription
RegNoRegNoYes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetOpenBillingAccountByRegNo10Response

FieldDatatypeDescription
CompanyNoString 
RegNoRegNo 
BillingAccountListList<OpenBillingAccountInfo> 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Classes

OpenBillingAccountInfo

FieldDatatypeDescription
BillingAccountNoString 
BillingAccountAliasString 
DescriptionString 
OpenBillBillDetail 
PaymentBankAccountPaymentBankAccount 
CurrentBillingAccountDebtdecimal 
PaymentReferencestring 

RegisterBillPSPPaymentBillingAccountNo10

Class diagram

1574428685798-189.png

Request parameters

RegisterBillPSPPaymentBillingAccountNo10Request

FieldDatatypeRequiredDescription
BillingAccountNostring(15)Yes 
AmountDecimalYes 
PaymentDateDateTimeYes 
SellerTransactionIdStringYes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

RegisterBillPSPPaymentBillingAccountNo10Response

FieldDatatypeDescription
ResponseCodeString 
ResponseMessageString 
TraceIdString 

RegisterBillDirectPaymentByBillingAccountNo10

Class diagram

1574431509616-621.png

Request parameters

RegisterBillDirectPaymentByBillingAccountNo10Request

FieldDatatypeRequiredDescription
AmountDecimalYes 
BillingAccountNoString(15)Yes 
PaymentDateDateTimeYes 
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

RegisterBillDirectPaymentByBillingAccountNo10Request

FieldDatatypeDescription
ResponseCodeString 
ResponseMessageString 
TraceIdString 

CustomerService methods

The complete Wsdl specification for this service can be found at:
https://connect.internaltest.payex.com/PxR/CustomerService.svc

 (Username/password security model)

GetcustomerCurrentStateByCustomerNo

Get information about current state of a customer.

Class diagram

7-class-diagram-external.png

Request parameters

GetCustomerCurrentStateByCustomerNoRequest

FieldDatatypeRequiredDescription
CustomerNumberString(15)Yes 
TrackingUserEMailStringNo 

Response parameters

GetCustomerCurrentStateByCustomerNoResponse

FieldDatatypeDescription
CustomerConsentsCustomerConsentArray.
CustomerInfoCustomerInfo 
CustomerNoString 
CustomerStatusCustomerStatusArray.
RegNoRegNo 

Classes

CustomerConsent

FieldDatatypeDescription
ConsentTypeCodeIntSee the consent type codes table for available consent type codes.

CustomerInfo

FieldDatatypeDescription
NameString 
DistributionAddressInfoDistributionAddressInfo 
LanguageString 
LegalEntityCodeIntSee the legal entity codes table for available legal entity codes.
VatNoString 
Category  

CustomerStatus

FieldDatatypeDescription
CustomerStatusTypeCodeIntSee code specification.

DistributionAddressInfo

FieldDatatypeRequiredDescription
AddressesArrayYesSee address.
EMailAddressStringNo 
CellphoneStringNo 

Address

FieldDatatypeRequiredDescription
AddresseeString(72)Yes 
StreetAdressString(35)No 
ZipCodeString(9)Yes 
CityString(27)Yes 
CoAddressString(35)No 
CountryCodeString(2)Yes 

GetCustomerCurrentStateByRegNo10

Class diagram

1574422177227-663.png

Request parameters

GetCustomerCurrentStateByRegNo10Request

FieldDatatypeRequiredDescription
RegNoRegNoYes 
TrackingUserEMailStringYes 
TraceIdStringYes 

Response parameters

GetCustomerCurrentStateByRegNo10Response

FieldDatatypeDescription
CustomerConsentsCustomerConsentArray.
CustomerInfoCustomerInfo 
CustomerNoString 
CustomerStatusCustomerStatusArray.
RegNoRegNo 

Appendix 1 Shared Classes

Response parameters

GetInvoicePDFResponse

FieldDatatypeDescription
PdfByte[] 
RegNoRegNo 
CustomerNoString 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

GetInvoiceInformationResponse

FieldDatatypeDescription
CompanyNoString 
RegNoRegNo 
CustomerNoString 
CustomerNameString 
InvoiceInvoice 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

RegNo

FieldDatatypeDescription
CountryCodeString 
ValueString 

Invoice

FieldDatatypeDescription
PaymentReferenceString 
BillNoString 
BillStatusCodeIntSee the bill type code table for available bill type codes.
ExternalInvoiceIdString 
ExternalReferenceString 
SellerNoString 
BillDateDateTime 
DueDateDateTime (Optional) 
OriginalAmountDecimal 
InterestInterest 
CurrentBalanceListList <Balance> 
CurrencyCodeString 
CurrentClaimLevelCodeIntSee the claim level codes table for available claim level codes.
CollectionStatusCodeIntSee the collection status code table for available collection status codes.
PaymentBanAccountPaymentBankAccount 
PaymentTypeString 
ActiveRespiteActiveRespite 
ActivePaymentOrderActivePaymentOrder 
BillIdLong 
BillTypeCodeByteSee the bill type code table for available bill type codes.
InvoiceHistoryList <InvoiceHistory> 

Interest

FieldDatatypeDescription
CurrentInterestRatedecimal 
InterestIntervalCodebyte 

Balance

FieldDatatypeDescription
BalanceTypeCodeintSee the balance type codes table for available balance type codes.
Amountdecimal 

PaymentBankAccount20 inherit PaymentBankAccount

FieldDatatypeDescription
PaymentTypeNameString 

PaymentBankAccount

FieldDatatypeDescription
BankAccountNoString 
BankAccountTypeString 
BICString 
IBANString 

ActiveRespite

FieldDatatypeDescription
RespiteValidtoDateDateTime 
RespiteTypeCodeint 

ActivePaymentOrder

FieldDatatypeDescription
PaymentTypeString 
ExecutionDateDateTime 

InvoiceHistory

FieldDatatypeDescription
BillDateDateTime 
BillIdlong 
BillTypeCodebyteSee the bill type code table for available bill type codes.

GetClosedInvoiceInformation20Response

FieldDatatypeDescription
CompanyNoString 
CustomerNostring 
CustomerNameString 
InvoiceListList<ClosedInvoice20>See ClosedInvoice20

ClosedInvoice20

FieldDatatypeDescription
CurrencyCodeString 
BillNostring 
BillStatusCodeInt 
ExternalInvoiceIdString 
BillDateDateTime 
DueDateDateTime? 
ExternalBillTypeString 
OriginalAmountDecimal 
SellerNameString 
SellerNoString 

GetInvoiceInformation20Response

FieldDatatypeDescription
CompanyNoString 
RegNoRegNo 
CustomerNostring 
CustomerNameString 
InvoiceInvoiceInformation20 

InvoiceInformation20 inherit OpenInvoice20

FieldDatatypeDescription
PenaltyIntestIntrest 
CurrentBalanceList<Balance> 
InvoiceHistoryList<InvoiceHistory20> 

InvoiceHistory20

FieldDatatypeDescription
BillDateDateTime 
ExternalBillTypeString 
BillAmountDecimal? 

OpenInvoice20 inherit ClosedInvoice20

FieldDatatypeDescription
CurrentDebtDecimal 
PaymentBankAccountPaymentBankAccount 
PaymentTypeString 
ActiveRespiteActiveRespite20 
ActivePaymentOrderActivePaymentOrder 
PaymentRefrenceString 
ExportedToCollectionBool 

ActiveRespite20

FieldDatatypeDescription
RespiteValidToDateDateTime? 
RespiteTypeCodeInt 

BillDetail

FieldDatatypeDescription
ExternalBillIdString 
DueDateDateTime 
ExportedToCollectionBool 
BillNoString 
ActiveRespiteActiveRespite20 
ActivePaymentOrderActivePaymentOrder 
CurrentBalanceListList<Balance> 
BillHistoryListList<BillHistory> 

BillHistory11

FieldDatatypeDescription
BillDateDateTime 
ExternalBillTypeString 
BillAmountDecimal 
BillNoString 

Appendix 2 Code specification

Bill status codes

BillStatusCodesDescription
1Open
2Closed
3Closed_Diff
4Closed_Loss
5Reversed
6Arrears
7Closed_Rest
8Closed_Convert
9Closed_Sold
10Closed_Reversal
11Pending

Claim level codes

ClaimLevelCodeDescription
1Invoice
2RestReminderSent
3ReminderSent
4RestReminderSent
5SecondReminderSent
6RestReminderSent
7CollectionClaimSent
8RestReminderSent
9*DebtCollection*
10Late Fee, credit account
11TerminationNoticeSent, credit account

*Additional fees and interest may have occured in collection system, but is not included in the response. 

Bill type codes

BillTypeCodeDescription
1Invoice
4CreditInvoice

Consent type codes

ConsentTypeCodeDescription
1BGAGSE
2EInvoiceB2CSE
3EInvoiceB2CNO
4BKAGNO
5KivraSE
6EInvoiceB2CFI

CustomerStatus type codes

CustomerStatusTypeCodeDescription
1ConfirmedDeceased
2ConfirmedBankruptcy
3ActiveComplaints

Legal entity codes

LegalEntiytCodeDescription
NoneNone
PrivatePrivate
BusinessBusiness

Balance type codes

BalanceTypeCodeDescription
0None
1Capital
2ReminderFee
3PenaltyInterest
4CalculatedPenaltyInterest
5CollectionFee
6BusinessReminderFee
7BillingFee
8DelayFee
9DebtInterest
10DebtCollectionCharge
11Rounding

Collection status codes

CollectionStatusCodeDescription
1PreDebtCollection
2DebtCollection
3LegalProcess
4Monitoring
5External
6Closed
7ReturnedWrongAddress
Created by David Persson on 2020/01/21 09:36