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	String(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

GetInvoiceInformationByExternalInvoiceId

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

GetClosedInvoiceInformationByCustomerNoRequest
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.

AddPaymentOrderOnDueDate

Add paymentorder to an open invoice.

Class diagram

Request parameters

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

Response parameters

AddPaymentOrderOnDueDate
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

Error codes

GetCustomerCurrentStateByCustomerNoResponse
Code	Name	Description
5080	InvalidBillNo	No bill found with billNo and companyNo
5117	AddPaymentOrderException	Customer ain't available for PaymentOrder.
5002	InvalidOpenBill	BillStatus ain't Open

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

DeletePaymentOrder

Abort a PaymentOrder for billNo

Class diagram

Request parameters

DeletePaymentOrderRequest
Field	Datatype	Required	Description
BillNo	String	Yes	Bill to match paymentorder.
CompanyNo	String	Yes	Company number
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

DeletePaymentOrderResponse
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

Error codes

DeletePaymentOrderResponse
Code	Name	Description
5080	InvalidBillNo	BillNo is invalid
5115	PaymentOrderNotFound	Found no paymentorders connected to bill
5116	DeletePaymentOrderNotAllowed	Found paymentOrder but are not allowed to Delete since the paymentorder has begun/finished processing

RegisterInvoiceDirectPaymentByBillNo10

Register a direct payment on given invoice.

Class diagram

Request parameters

RegisterInvoiceDirectPaymentByBillNo10Request
Field	Datatype	Required	Description
Amount	Decimal	Yes	DirectPayment Amount.
BillNo	String	Yes	Bill to match payment to.
PaymentDate	DateTime	Yes	Date when payment occured.
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

RegisterInvoiceDirectPaymentByBillNo10Response
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

Error codes

GetCustomerCurrentStateByCustomerNoResponse
Code	Name	Description
5080	InvalidBillNo	BillNo is invalid
1207	InvalidAmount	Amount is invalid
5074	InvalidDate	PaymentDate is not within a valid date

AddInvoiceCopyOrderByBillNo10

Order a copy of the invoice to be delivered.

Class diagram

Request parameters

AddInvoiceCopyOrderByBillNo10Request
Field	Datatype	Required	Description
BillNo	String	Yes
DistributionMethod	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

RegisterInvoiceDirectPaymentByBillNo10Response
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

Error codes

GetCustomerCurrentStateByCustomerNoResponse
Code	Name	Description
5089	BillsNotFound	Found no matching Invoices for BillNo

GetClosedInvoiceInformationByCustomerNo20

Get information about a customer's closed invoice(s) by customer number.

Class diagram

Request parameters

GetClosedInvoiceInformationByCustomerNo20Request
Field	Datatype	Required	Description
CustomerNo	String	Yes
TrackingUserEmail	String	Yes	User info for trackability.
TraceId		yes

Response parameters

GetClosedInvoiceInformation20Response

GetClosedInvoiceInformationByRegNo20

Get information about a customer's closed invoice(s) by social security number.

Class diagram

Request parameters

GetClosedInvoiceInformationByRegNo20Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes	See RegNo
TrackingUserEmail	String	Yes	User info for trackability.
TraceId		yes

Response parameters

GetClosedInvoiceInformation20Response

Error codes

GetClosedInvoiceInformation20Response
Code	Name	Description
5006	ExpectedCustomerNumber	Found multiple customer on RegNo, use CustomerNo instead.
5075	MissingAccountForBill	Found no matching customer for RegNo.
1024	ErrorInvalidRegNo	Invalid RegNo format.

GetInvoiceInformationByBillNo20

Class diagram

Request parameters

GetInvoiceInformationByBillNo20Request
Field	Datatype	Required	Description
BillNo	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoinceInformation20Response

Error codes

GetInvoinceInformation20Response
Code	Name	Description
5072	InvalidExternalBillId	ExternalInvoiceId does not match any valid invoices.
5089	BillsNotFound	Invoice match but invoice not valid. May be older than 1 year.

GetInvoiceInformationByExternalInvoiceId20

Class diagram

Request parameters

GetInvoiceInformationByExternalInvoiceId20Request
Field	Datatype	Required	Description
ExternalInvoiceId	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoinceInformation20Response

Error codes

GetInvoinceInformation20Response
Code	Name	Description
5072	InvalidExternalBillId	ExternalInvoiceId does not match any valid invoices.
5089	BillsNotFound	Invoice match but invoice not valid. May be older than 1 year.

GetInvoicePdfByBillNoExternalBillType10

Class diagram

Request parameters

GetInvoicePdfByBillNoExternalBillType10Request
Field	Datatype	Required	Description
BillNo	String	Yes
ExternalBillType	String	Yes	Document type. Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoicePDFResponse

Error codes

GetInvoincePDFResponse
Code	Name	Description
5046	InvalidAccountType	Wrong account type. The requested bill number is not an invoice.
5080	InvalidBillNo	Invoice document not found.
5095	ExternalBillTypeCode	Invalid ExternalBillType.

GetOpenInvoiceInformationByCustomerNo20

Class diagram

Request parameters

GetOpenInvoiceInformationByCustomerNo20Request
Field	Datatype	Required	Description
CustomerNo	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetOpenInvoiceInformation20Response

GetOpenInvoiceInformationByRegNo20

Class diagram

Request parameters

GetOpenInvoiceInformationByRegNo20Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetOpenInvoiceInformation20Response

RegisterInvoicePSPPaymentByBillNo10

Class diagram

Request parameters

RegisterInvoicePSPPaymentByBillNoRequest
Field	Datatype	Required	Description
BillNo	String	Yes
Amount	Decimal	Yes
PaymentDate	DateTime	Yes
SellerTransactionId	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

RegisterInvoicePSPPaymentByBillNoResponse
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

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	See code specification.

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

GetCustomerCurrentStateByRegNo10

Class diagram

Request parameters

GetCustomerCurrentStateByRegNo10Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes
TrackingUserEMail	String	Yes
TraceId	String	Yes

Response parameters

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

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
RegNo	RegNo
CustomerNo	String
Invoice	Invoice
ResponseCode	String
ResponseMessage	String
TraceId	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.
PaymentBankAccount	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>

PaymentBankAccount20 inherit PaymentBankAccount
Field	Datatype	Description
PaymentTypeName	String

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

ActiveRespite
Field	Datatype	Description
RespiteValidToDate	DateTime
RespiteTypeCode	int

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

GetClosedInvoiceInformation20Response
Field	Datatype	Description
CompanyNo	String
CustomerNo	string
CustomerName	String
InvoiceList	List<ClosedInvoice20>	See ClosedInvoice20

ClosedInvoice20
Field	Datatype	Description
CurrencyCode	String
BillNo	string
BillStatusCode	Int
ExternalInvoiceId	String
BillDate	DateTime
DueDate	DateTime?
ExternalBillType	String
OriginalAmount	Decimal
SellerName	String
SellerNo	String

GetInvoiceInformation20Response
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
CustomerNo	string
CustomerName	String
Invoice	InvoiceInformation20

InvoiceInformation20 inherit OpenInvoice20
Field	Datatype	Description
PenaltyIntest	Intrest
CurrentBalance	List<Balance>
InvoiceHistory	List<InvoiceHistory20>

InvoiceHistory20
Field	Datatype	Description
BillDate	DateTime
ExternalBillType	String
BillAmount	Decimal?

OpenInvoice20 inherit ClosedInvoice20
Field	Datatype	Description
CurrentDebt	Decimal
PaymentBankAccount	PaymentBankAccount
PaymentType	String
ActiveRespite	ActiveRespite20
ActivePaymentOrder	ActivePaymentOrder
PaymentReference	String
ExportedToCollection	Bool

RegNo
Field	Datatype	Description
CountryCode	String
Value	String	National identification number

Interest
Field	Datatype	Description
CurrentInterestRate	decimal
InterestIntervalCode	byte	See the Interest Interval Codes for available intererest interval codes.

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

PaymentBankAccount20 inherit PaymentBankAccount
Field	Datatype	Description
PaymentTypeName	String

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

ActiveRespite
Field	Datatype	Description
RespiteValidtoDate	DateTime
RespiteTypeCode	int	See the respite type code table for available respite type codes.

ActivePaymentOrder
Field	Datatype	Description
PaymentType	String
ExecutionDate	DateTime

ActiveRespite20
Field	Datatype	Description
RespiteValidToDate	DateTime
RespiteTypeCode	Int	See the respite type code table for available respite type codes.

ActiveRespite21
Field	Datatype	Description
RespiteValidToDate	DateTime
RespiteTypeCode	Int	See the respite type code table for available respite type codes.

GetInvoiceInformation20Response
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
CustomerNo	string
CustomerName	String
Invoice	InvoiceInformation20

BillDetail
Field	Datatype	Description
ExternalBillId	String
DueDate	DateTime
ExportedToCollection	Bool
BillNo	String
ActiveRespite	ActiveRespite20
ActivePaymentOrder	ActivePaymentOrder
CurrentBalanceList	List<Balance>
BillHistoryList	List<BillHistory>

BillHistory
Field	Datatype	Description
BillDate	DateTime
ExternalBillType	String	I_Invoice I_Reminder I_Collection I_RestReminder (reminder of fees that has not been payed on the invoice)
BillAmount	Decimal

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
5	KivraSE
6	EInvoiceB2CFI
7	EInvoice20B2CNO
8	AGDK
9	PSPRecurringCardConsent
10	EcBoks

CustomerStatus type codes
CustomerStatusTypeCode	Description
1	ConfirmedDeceased
2	ConfirmedBankruptcy
3	ActiveComplaints

Legal entity codes
LegalEntiytCode	Description
None	None
1	Business
2	Private

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

Interest Interval Codes
InterestIntervalCode	Description
1	Year
2	Month

Respite type codes
InterestIntervalCode	Description
1	Stop
2	Stop, complaint
3	Stop, return
4	Stop, complaint rejected
5	Stop, complaint approved
6	Stop, collection inquiry
7	Stop, deceased
10	Respite
11	Respite, interest inquiry
12	Respite, interest free
13	Respite, installment plan
20	Respite, disbursement
25	Respite, collection inquiry

Address type codes
AddressTypeCode	Description
1	BillingAddress
3	LegalAddress

TransactionTypeGroup codes
AddressTypeCode	Description
0	Unknown
1	Payment
2	DirectPayment
3	Adjustment
4	SurplusAdjustment
5	Writedown
6	Collection
7	CollectionAccount
8	Disbursement
9	Monitoring
10	Invoice
11	Credit
12	ReminderFee
13	CollectionFee
14	Interest
15	DisbursementReturned
16	InvoiceFee
17	Converted

TransactionCause codes
TransactionCauseCode	Description
1	Bankruptcy
2	CompositionArrangement
3	Settlement
4	WrongAddress
5	Complaint
6	WrongRegNo
7	UnderAge
8	Deceased
9	Fraud
10	Dispute
15	Monitoring
20	ApprovedDiff
21	Remission
22	Unknown
23	PurchasedClaim
24	DirectPayment
25	Migration
26	ReversalCorrection
27	PurchaseCorrection
28	CashWithdrawalCorrection
29	CashWithdrawal
30	InterestAsIncome

ComplaintCause codes
ComplaintCauseCode	Description
1	InvoiceComplaint
2	FraudComplaint
3	ContractComplaint
4	ImproperComplaint