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

Request parameters

GetInvoiceByBillNoRequest
Field	Datatype	Required	Description
BillNo	String(15)	Yes
TrackingUserEmail	Sting(50)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoicePDFResponse

GetInvoicePdfByExternalInvoiceId

Gets a specific invoice document in the format of PDF

Class diagram

Request parameters

GetInvoicePdfByExternalInvoiceIdRequest
Field	Datatype	Required	Description
ExternalInvoiceId	String(15)	Yes
TrackingUserEmail	String(50)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoicePDFResponse

GetInvoiceInformationByBillNo

Gets information about a specific invoice

Class diagram

Request parameters

GetInvoiceInformationByBillNoRequest
Field	Datatype	Required	Description
BillNo	String(15)	Yes
TrackingUserEmail	String(50)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoiceInformationResponse

GetInvoiceIformationByExternalInvoiceId

Gets information about a specific invoice

Class diagram

Request parameters

GetInvoiceByExternalInvoiceIdRequest
Field	Datatype	Required	Description
ExternalInvoiceId	String (15)	Yes
TrackingUserEmail	String (50)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoiceInformationResponse

GetOpenInvoiceInformationByCustomerNo

Gets open invoices

Class diagram

Request parameters

GetOpenInvoiceInformationByCustomerNoRequest
Field	Datatype	Required	Description
CustomerNo	String(15)	Yes	CustomerNo is your unique identifier of the customer.
TrackingUserEMail	String	No	User info for trackability.
TraceId	String	Yes

Response parameters

GetOpenInvoiceInformationByCustomerNoResponse
Field	Datatype	Description
CompanyNo	String
CustomerNo	String	CustomerNo is you Unique identifier of the customer.
CustomerName	String
InvoiceList	List <OpenInvoice>
ResponseCode	String
ResponseMessage	String
TraceId	String

Classes

OpenInvoice
Field	Datatype	Description
BillNo	String
BillStatusCode	Int	See the bill status code table for available status codes.
ExternalInvoiceId	String	Additional unique invoice identifier.
BillDate	DateTime
DueDate	DateTime(Optional)	Empty if BillTypeCode is Invoice.
BillTypeCode	Byte	See the bill type code table for available bill type codes.
OriginalAmount	Decimal
CurrentDebt	Decimal
CurrencyCode	String
CurrentClaimLevelCode	Int	See the claim level code table for available claim level codes.
PaymentBankAccount	PaymentBankAccount
PaymentType	String
ActiveRespite	ActiveRespite
ActivePaymentOrder	ActivePaymentOrder

GetClosedInvoiceInformationByCustomerNo

Gets closed invoices (status “Closed” only)

Class diagram

Request parameters

GetClosedInvoiceInformationCustomerNoRequest
Field	Datatype	Required	Description
CustomerNo	String(15)	Yes	CustomerNo is your unique identifier for the customer.
TrackingUserEMail	String	No	User info for trackability.
TraceId	String	Yes

Response parameters

GetClosedInvoiceInformationByCustomerNoResponse
Field	Datatype	Description
CompanyNo	String	Yoyr accounts receivable number at PayEx.
CustomerNo	String	CustomerNo is you Unique identifier of the customer.
CustomerName	String
InvoiceList	List <ClosedInvoice>
ResponseCode	String
ResponseMessage	String
TraceId	String

Classes

ClosedInvoice
Field	Datatype	Description
BillNo	String
BillStatusCode	Int	See the bill status code table for available status codes.
ExternalInvoiceId	String	Additional unique invoice identifier in accounts receivable.
BillDate	DateTime
DueDate	DateTime(Optional)	Empty if BillTypeCode is Invoice.
BillTypeCode	Byte	See the bill type code table for available bill type codes.
OriginalAmount	Decimal
CurrencyCode	String

AddInvoiceRespiteByBillNo10

Add respite date to an open invoice.

Class diagram

Request parameters

AddInvoiceRespiteByBillNo10Request
Field	Datatype	Required	Description
BillNo	String(15)	Yes	Bill Number.
RespiteCause	String(250)	Yes	Reason for respite.
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes
ValidToDate	DateTime	Yes

Response parameters

AddInvoiceRespiteByBillNo10Response
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

Error codes

GetCustomerCurrentStateByCustomerNoResponse
Code	Name	Description
5074	InvalidDate	ValidToDate is not within a valid date.
5046	InvalidAccountType	Bill of BillNo is not of a valid AccountType.
1208	InvalidAccountStatus	Respite not a valid action on this bill.

ConvertInvoiceToAccount10

Convert an invoice account to a credit account.

Class diagram

Request parameters

ConvertInvoiceToAccount10Request
Field	Datatype	Required	Description
BillNo	String(15)	Yes	Bill Number.
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

ConvertInvoiceToAccount10Response
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

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

Request parameters

GetCustomerCurrentStateByCustomerNoRequest
Field	Datatype	Required	Description
CustomerNumber	String(15)	Yes
TrackingUserEMail	String	No

Response parameters

GetCustomerCurrentStateByCustomerNoResponse
Field	Datatype	Description
CustomerConsents	CustomerConsent	Array.
CustomerInfo	CustomerInfo
CustomerNo	String
CustomerStatus	CustomerStatus	Array.
RegNo	RegNo

Classes

CustomerConsent
Field	Datatype	Description
ConsentTypeCode	Int	See the consent type codes table for available consent type codes.

CustomerInfo
Field	Datatype	Description
Name	String
DistributionAddressInfo	DistributionAddressInfo
Language	String
LegalEntityCode	Int	See the legal entity codes table for available legal entity codes.
VatNo	String
Category

CustomerStatus
Field	Datatype	Description
CustomerStatusTypeCode	Int

DistributionAddressInfo
Field	Datatype	Required	Description
Addresses	Array	Yes	See address.
EMailAddress	String	No
Cellphone	String	No

Address
Field	Datatype	Required	Description
Addressee	String(72)	Yes
StreetAdress	String(35)	No
ZipCode	String(9)	Yes
City	String(27)	Yes
CoAddress	String(35)	No
CountryCode	String(2)	Yes

Appendix 1 Shared Classes

Response parameters

GetInvoicePDFResponse
Field	Datatype	Description
Pdf	Byte[]
RegNo	RegNo
CustomerNo	String
ResponseCode	String
ResponseMessage	String
TraceId	String

GetInvoiceInformationResponse
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
CustomerNo	String
CustomerName	String
Invoice	Invoice
ResponseCode	String
ResponseMessage	String
TraceId	String

RegNo
Field	Datatype	Description
CountryCode	String
Value	String

Invoice
Field	Datatype	Description
PaymentReference	String
BillNo	String
BillStatusCode	Int	See the bill type code table for available bill type codes.
ExternalInvoiceId	String
ExternalReference	String
SellerNo	String
BillDate	DateTime
DueDate	DateTime (Optional)
OriginalAmount	Decimal
Interest	Interest
CurrentBalanceList	List <Balance>
CurrencyCode	String
CurrentClaimLevelCode	Int	See the claim level codes table for available claim level codes.
CollectionStatusCode	Int	See the collection status code table for available collection status codes.
PaymentBanAccount	PaymentBankAccount
PaymentType	String
ActiveRespite	ActiveRespite
ActivePaymentOrder	ActivePaymentOrder
BillId	Long
BillTypeCode	Byte	See the bill type code table for available bill type codes.
InvoiceHistory	List <InvoiceHistory>

Interest
Field	Datatype	Description
CurrentInterestRate	decimal
InterestIntervalCode	byte

Balance
Field	Datatype	Description
BalanceTypeCode	int	See the balance type codes table for available balance type codes.
Amount	decimal

PaymentBankAccount
Field	Datatype	Description
BankAccountNo	String
BankAccountType	String
BIC	String
IBAN	String

ActiveRespite
Field	Datatype	Description
RespiteValidtoDate	DateTime
RespiteTypeCode	int

ActivePaymentOrder
Field	Datatype	Description
PaymentType	String
ExecutionDate	DateTime

InvoiceHistory
Field	Datatype	Description
BillDate	DateTime
BillId	long
BillTypeCode	byte	See the bill type code table for available bill type codes.

Appendix 2 Code specification

Bill status codes
BillStatusCodes	Description
1	Open
2	Closed
3	Closed_Diff
4	Closed_Loss
5	Reversed
6	Arrears
7	Closed_Rest
8	Closed_Convert
9	Closed_Sold
10	Closed_Reversal
11	Pending

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

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

Bill type codes
BillTypeCode	Description
1	Invoice
4	CreditInvoice

Consent type codes
ConsentTypeCode	Description
1	BGAGSE
2	EInvoiceB2CSE
3	EInvoiceB2CNO
4	BKAGNO

Legal entity codes
LegalEntiytCode	Description
None	None
Private	Private
Business	Business

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

Collection status codes
CollectionStatusCode	Description
1	PreDebtCollection
2	DebtCollection
3	LegalProcess
4	Monitoring
5	External
6	Closed
7	ReturnedWrongAddress