ExternalServicesmanual

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

You can also use the PDF manual found here.

InvoiceService methods

The complete Wsdl specification for this service can be found at:

https://connect.payex.com//PxR/InvoiceService.svc?wsdl

 (Username/password security model)

GetInvoicePdfByBillNo

Gets a specific invoice document in the format of PDF

Class diagram

1-class-diagram-external.png

Request parameters

GetInvoiceByBillNoRequest
FieldDatatypeRequiredDescription
BillNoString(15)Yes 
TrackingUserEmailSting(50)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetInvoicePDFResponse

GetInvoicePdfByExternalInvoiceId

Gets a specific invoice document in the format of PDF

Class diagram

2-class-diagram-external.png

Request parameters

GetInvoicePdfByExternalInvoiceIdRequest
FieldDatatypeRequiredDescription
ExternalInvoiceIdString(15)Yes 
TrackingUserEmailString(50)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetInvoicePDFResponse

GetInvoiceInformationByBillNo

Gets information about a specific invoice

Class diagram

3-class-diagram-external.png

Request parameters

GetInvoiceInformationByBillNoRequest
FieldDatatypeRequiredDescription
BillNoString(15)Yes 
TrackingUserEmailString(50)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetInvoiceInformationResponse

GetInvoiceIformationByExternalInvoiceId

Gets information about a specific invoice

Class diagram

4-class-diagram-external.png

Request parameters

GetInvoiceByExternalInvoiceIdRequest
FieldDatatypeRequiredDescription
ExternalInvoiceIdString (15)Yes 
TrackingUserEmailString (50)YesUser info for trackability.
TraceIdStringYes 

Response parameters

GetInvoiceInformationResponse

GetOpenInvoiceInformationByCustomerNo

Gets open invoices

Class diagram

5-class-diagram-external.png

Request parameters

GetOpenInvoiceInformationByCustomerNoRequest
FieldDatatypeRequiredDescription
CustomerNoString(15)YesCustomerNo is your unique identifier of the customer.
TrackingUserEMailStringNoUser info for trackability.
TraceIdStringYes 

Response parameters

GetOpenInvoiceInformationByCustomerNoResponse
FieldDatatypeDescription
CompanyNoString 
CustomerNoStringCustomerNo is you Unique identifier of the customer.
CustomerNameString 
InvoiceListList <OpenInvoice> 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Classes

OpenInvoice

FieldDatatypeDescription
BillNoString 
BillStatusCodeIntSee the bill status code table for available status codes.
ExternalInvoiceIdStringAdditional unique invoice identifier.
BillDateDateTime 
DueDateDateTime(Optional)Empty if BillTypeCode is Invoice.
BillTypeCodeByteSee the bill type code table for available bill type codes.
OriginalAmountDecimal 
CurrentDebtDecimal 
CurrencyCodeString 
CurrentClaimLevelCodeIntSee the claim level code table for available claim level codes.
PaymentBankAccountPaymentBankAccount 
PaymentTypeString 
ActiveRespiteActiveRespite 
ActivePaymentOrderActivePaymentOrder 

GetClosedInvoiceInformationByCustomerNo

Gets closed invoices (status “Closed” only)

Class diagram

6-class-diagram-external.png

Request parameters

GetClosedInvoiceInformationCustomerNoRequest
FieldDatatypeRequiredDescription
CustomerNoString(15)YesCustomerNo is your unique identifier for the customer.
TrackingUserEMailStringNoUser info for trackability.
TraceIdStringYes 

Response parameters

GetClosedInvoiceInformationByCustomerNoResponse
FieldDatatypeDescription
CompanyNoStringYoyr accounts receivable number at PayEx.
CustomerNoStringCustomerNo is you Unique identifier of the customer.
CustomerNameString 
InvoiceListList <ClosedInvoice> 
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Classes

ClosedInvoice

FieldDatatypeDescription
BillNoString 
BillStatusCodeIntSee the bill status code table for available status codes.
ExternalInvoiceIdStringAdditional unique invoice identifier in accounts receivable.
BillDateDateTime 
DueDateDateTime(Optional)Empty if BillTypeCode is Invoice.
BillTypeCodeByteSee the bill type code table for available bill type codes.
OriginalAmountDecimal 
CurrencyCodeString 

AddInvoiceRespiteByBillNo10

Add respite date to an open invoice.

Class diagram
1573563792142-225.png
Request parameters

AddInvoiceRespiteByBillNo10Request
FieldDatatypeRequiredDescription
BillNoString(15)YesBill Number.
RespiteCauseString(250)YesReason for respite.
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 
ValidToDateDateTimeYes 

Response parameters

AddInvoiceRespiteByBillNo10Response
FieldDatatypeDescription
ResponseCodeString 
ResponseMessageString 
TraceIdString 

Error codes

GetCustomerCurrentStateByCustomerNoResponse
CodeNameDescription
5074InvalidDateValidToDate is not within a valid date.
5046InvalidAccountTypeBill of BillNo is not of a valid AccountType.
1208InvalidAccountStatusRespite not a valid action on this bill.

ConvertInvoiceToAccount10

Convert an invoice account to a credit account.

Class diagram

1573569373687-299.png

Request parameters

ConvertInvoiceToAccount10Request
FieldDatatypeRequiredDescription
BillNoString(15)YesBill Number.
TrackingUserEMailString(1-256)YesUser info for trackability.
TraceIdStringYes 

Response parameters

ConvertInvoiceToAccount10Response
FieldDatatypeDescription
ResponseCodeString 
ResponseMessageString 
TraceIdString 

RegisterInvoiceDirectPaymentByBillNo10

 

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
CustomerStatusTypeCodeInt 

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 

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 

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.

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

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 2019/06/20 09:24