PeleBilling

Index

PeleBilling System – Customers

Login Screen:

The behavior in this screen is the same as in Pele-Tracking.
The system checks for expired and near-expiry statuses and behaves accordingly, just like Pele-Tracking.
The system allows password changes, similar to Pele-Tracking.
The system manages a session for 10 minutes and automatically disconnects, just like Pele-Tracking.

Customers Table (Default Screen)

You can search by (select from the dropdown list):

  • Customer number (default).
  • First name.
  • Last name.
  • ID number.
  • Phone.
  • Mobile.
  • Fax.
  • Email.

The buttons: Edit, Manage Standing Orders, Delete Customer – are only active if a row is selected.
Clicking “Create Customer” opens the “New Customer” screen (in a pop-up).
Clicking “Edit” opens the “Edit Customer” screen (in a pop-up).
Clicking “Manage Standing Orders” opens the “Manage Standing Orders” screen (in a pop-up).
Clicking on the customer’s name (first or last name) opens the “Account Status” screen (in a pop-up).
Clicking “Delete Customer” will show a warning message.

The actual deletion changes the customer’s status.
It is important to have a decision-making conversation regarding customer deletion.

New Customer / Edit Customer Pop-up (Customer Table)

All fields highlighted in yellow are editable.
Mandatory fields are marked with an asterisk. If they are not filled, a message will appear accordingly.
There must be a structure check for fields: Phone, Mobile, Fax, and Email.
After creating a new customer and clicking Finish, a message will appear allowing you to proceed to manage the customer’s standing orders.
The customer number field will display an automatic number suggestion, which can be changed.
Two customers cannot have the same customer number.
The customer number cannot be changed while editing.
The customer number is unique within a specific user context.

The customer’s name will display the first name and last name of the customer.
If you click Cancel, you will return to the customer management table. If you click Confirm, the “Manage Standing Orders” screen (in a pop-up) will appear.

After saving a new customer, the system will filter by the customer’s ID number and display the results in the grid (as search results).

Manage Standing Orders Pop-up (Customer Table)

Upper Part of the Standing Orders Management:

All fields in yellow in the upper part are editable.
The upper part is always empty and is intended for filling in order to add a standing order.
Mandatory fields are marked with an asterisk. If they are not filled, a message will appear accordingly.
The “Day of the Month” field is active (and mandatory) only if “Yes” is selected for automatic payment.
Structure checks should be performed for fields: Credit Card Number, Expiry Date, Amount, Number of Charges (up to 3 digits), Start Date, Token.
If you choose to enter a token (you can select either a token or card and expiry), clicking “Add” will convert the token into a card.
The conversion must verify that the token exists and is valid; otherwise, the token will not be converted to a card. If the token is missing or invalid, a message will appear.
After conversion, the fields in the lower table will be populated.
If you choose to enter a card and expiry, the system will convert the card into a token for populating the lower table. If an error occurs, a message will appear.
The date field allows selection from a calendar.

Dropdown List Options:

  • Currency: Shekel (default), Dollar, Euro.
  • Charge For (Service Code): General (default), other options are loaded from the service code table.
  • Add VAT: No (default), Yes – if “Yes” is selected, VAT will be added to the amount during the charge.
  • Automatic Charge: No (default), Yes – if Yes is selected, the “Day of the Month” dropdown will open.
  • Day of the Month: 1 (default) to 28 – limited to 28 to support February.
  • The status field contains a dropdown list that changes based on the status:
    • Standing order that has started – Suspended | Active
    • Standing order that has not started – Deleted | Not Started
  • The status can be changed in the following cases:
    • Active > Suspended
    • Suspended > Active
    • Inactive > Deleted

PeleBilling API

2. Introduction

The PeleBilling API interface allows you to perform operations for customer and standing order management without needing a graphical interface.
API methods are divided into different modules based on topics.

3. Module Descriptions

The system contains the following modules:

Functional Details:

  • All input fields are defined as string, but you must follow the format defined for each field.
  • Fields marked with an asterisk (*) are mandatory.

3.1 Customer Management – WsPeleBillingCustomers

3.1.1 AddClient – Add a New Customer

Parameters:

Field Type/Format Description
userName * Username for the system instructions
password * Password
customerNo 1-999999999 Customer number. If customer numbering is not managed on the client side, use the GetNewClientNumber method to get a new customer number
fName * First name (max 16 characters)
lName * Last name (max 16 characters)
id * ID number (9 digits)
phone +,- numbers (max 16) Phone number
cellPhone +,- numbers (max 16) Mobile phone number
fax +,- numbers (max 16) Fax number
mail valid email (max 45) Email address
notes max 255 characters Notes

The method will return “000” if the customer creation is successful. In case of an error, a 3-digit error code will be returned.

3.1.2 UpdateClient – Update Existing Customer Details

Parameters:

Field Type/Format Description
userName * Username for the system instructions
password * Password
customerNo 1-999999999 Customer number (to find the customer)
fName * First name (max 16 characters)
lName * Last name (max 16 characters)
customerId * Customer ID (9 digits)
phone +,- numbers (max 16) Phone number
cellPhone +,- numbers (max 16) Mobile phone number
fax +,- numbers (max 16) Fax number
mail valid email (max 45) Email address
notes max 255 characters Notes

The method will return “000” if the update is successful. In case of an error, a 3-digit error code will be returned.

3.1.3 DeleteClient – Delete Customer

Parameters:

Field Type/Format Description
username * Username for the system instructions
password * Password
customerNo 1-999999999 Customer number

The method will return “000” if the deletion is successful. In case of an error, a 3-digit error code will be returned.
A deleted customer’s standing orders will not be charged.
Note: It is not possible to restore a customer after deletion!

3.1.4 GetNewClientNumber – Get the Next Customer Number

Parameters:

Field Type/Format Description
userName * Username for the system instructions
password * Password

The method will return the next customer number (INT).
The customer number is calculated based on the highest customer number in the system +1.

3.2 Standing Order Management – WsPeleBillingDirectDebits

3.2.1 AddDirectDebit – Add a Standing Order to a Customer

Parameters:

Field Type/Format Description
userName * Username for the system instructions
password * Password
customerNo 1-999999999 Customer number
creditCard up to 19 digits Credit card number (mandatory if no token is provided)
creditCardDateMmyy Mmyy Card expiry date (mandatory if no token is provided)
token up to 10 digits Token (if provided instead of card number)
total up to 9 digits Amount in agorot (100 agorot = 1 NIS)
currency Numeric (1=Shekel, 2=Dollar, 987=Euro) Currency of the payment
startDate dd/mm/yyyy Payment start date
paymentsNo Numeric Number of payments
paymentCodeNo Numeric Service code (default 0)
vat “0” or “1” VAT inclusion (yes/no)
autoCharge “0” (manual), “1” (automatic) Auto/manual charge
dayInMonth 1 to 28 Payment day of the month (limited to 28 for February)

The method will return “000” and the instruction number in the format “000,1”.
In case of an error, a 3-digit error code will be returned.

Notes:

  • startDate must be at least 1 day ahead of the current date.
  • dayInMonth must be greater than or equal to the startDate.
  • startDate must be in the same month as the first charge (e.g., if trying to create an order on 20/09 for the first charge on 1st October, you must send: startDate=01/10/2024 and dayInMonth=1).

 

PeleBilling API – Modules and Methods

3.1.2 UpdateDirectDebit – Update Standing Order Details

Parameters:

Field Type/Format Description
userName * System username
password * Password
customerNo 1-999999999 Customer number
debitNo Numeric Standing order number
total Up to 9 digits Amount in agorot
currency Numeric 1 = Shekel, 2 = Dollar, 987 = Euro
startDate dd/MM/yyyy Payment start date
paymentsNo Numeric Number of payments
paymentCodeNo Numeric Service/product code (default 0)
vat “0” (No), “1” (Yes) VAT inclusion (Yes/No)
autoCharge “0” (Manual), “1” (Automatic) Automatic/manual charge
dayInMonth Between 1-28 Payment day of the month. If manual, send day “1”.

Method Behavior:

  • The method will return “000” and the order number in the format “000,1” if successful.
  • In case of an error, a 3-digit error code will be returned.
  • Notes:
    • startDate should be at least one day ahead of the current date.
    • dayInMonth must be greater than or equal to startDate.
    • startDate must be in the same month as the first charge.

Cancellation/Freezing Standing Order:

  • To cancel or freeze an active standing order, use the DeleteDirectDebit method.
  • If you want to renew the order, create a new standing order with AddDirectDebit.

3.2.3 DeleteDirectDebit – Delete Standing Order

Parameters:

Field Type/Format Description
userName * System username
password * Password
customerNo 1-999999999 Customer number
debitNo Numeric Standing order number

Method Behavior:

  • The method will return “000” if the deletion is successful.
  • In case of an error, a 3-digit error code will be returned.
  • Note: It is not possible to restore a deleted standing order.

3.3 Standing Order Operations – WsPeleBillingJobs

3.3.1 SubmitJobManualBilling – Perform Manual Billing

Parameters:

Field Type/Format Description
userName * System username
password * Password
paymentCodeNo Numeric Service code. “-1” for all. Default is “-1”.
includeAutoCharge “true” / “false” Include automatic charges (default is false).
email Valid email Email address for sending confirmation. Default is user’s default email.

The method will return a 9-digit operation number for tracking in case of success. If there is an error, a 3-digit error code will be returned.

3.3.2 SubmitJobBillingCompletion – Complete Billing for the Previous Month

Parameters:

Field Type/Format Description
userName * System username
password * Password
paymentCodeNo Numeric Service code. “-1” for all. Default is “-1”.
includeAutoCharge “true” / “false” Include automatic charges (default is false).
email Valid email Email address for sending confirmation. Default is user’s default email.

The method will return a 9-digit operation number for tracking in case of success. If there is an error, a 3-digit error code will be returned.

3.3.3 SubmitJobDynamicBilling – Perform Billing for a Series of Standing Orders

Parameters:

Field Type/Format Description
userName * System username
password * Password
BillingDataJson JSON Array of standing orders in the following format:

  • cn – Customer Number

  • ddn – Direct Debit Instruction Number

  • am – Amount

  • cu – Currency

{ “cn”: 5, “ddn”: 2, “am”: 12000, “cu”: 1 }, …

The method will return a 9-digit operation number for tracking in case of success. If there is an error, a 3-digit error code will be returned.

3.4 Monitoring Standing Order Activity – WsPeleBillingReports

3.4.1 GetBillingList – Customer Account Status

Parameters:

Field Type/Format Description
userName * System username
password * Password
customerNo Numeric Customer number

The function returns a string response with all the charges performed in the selected month in the following format:

mathematica

Copy

Billing Month, Transaction Date, Order Number, Service Code, Card Number, Expiry Date, Token, Amount in Agorot, Currency – 1 (Shekel), 2 (Dollar), 987 (Euro), Transaction Status (Error Codes Table).

3.4.2 GetApprovedBillings – Approved Billing Report

Parameters:

Field Type/Format Description
userName * System username
password * Password
month mm/yyyy Month format

The function returns a string response with all approved charges performed in the selected month in the following format:

mathematica

Copy

Customer Number, Order Number, Service Code, Card Number, Expiry Date, Token, Amount in Agorot, Currency – 1 (Shekel), 2 (Dollar), 987 (Euro), Approval Number, Voucher Number.

3.4.3 GetBillingStatusSummary – Check Billing/Approval Status

Parameters:

Field Type/Format Description
userName * System username
password * Password
debitId Numeric Operation number received from standing orders

The function returns a string with the status in the following format: “Number of Successful Transactions, Number of Failed Transactions”.

3.4.4 GetExceptionsList – Exceptions Report

Parameters:

Field Type/Format Description
userName * System username
password * Password
month mm/yyyy Month format

The function returns a string response with all the charges that failed in the selected month in the following format:

mathematica

Copy

Customer Number, Order Number, Service Code, Card Number, Expiry Date, Token, Amount in Agorot, Currency – 1 (Shekel), 2 (Dollar), 987 (Euro), Transaction Status (Error Codes Table).

3.5 Service Codes – asmx.WsPeleBillingServiceCodes

3.5.1 AddProduct – Add Service Code

Parameters:

Field Type/Format Description
userName * System username
password * Password
paymentCodeName Alphanumeric Service name

The method will return a string response with the value “000” and the service code number.

3.5.2 UpdateProduct – Update Service Details

Parameters:

Field Type/Format Description
userName * System username
password * Password
paymentCodeNo Numeric Service code number
paymentCodeName Alphanumeric Service name

The method will return “000” if successful or a 3-digit error code in case of failure.

3.5.3 DeleteProduct – Delete Service Code

Parameters:

Field Type/Format Description
userName * System username
password * Password
paymentCodeNo Numeric Service code number

The method will return “000” if successful or a 3-digit error code in case of failure.

PeleBilling Error Messages

  • 704: A customer with the same internal customer number already exists in the system.
  • 705: Customer does not exist.
  • 706: Service code does not exist.
  • 707: Invalid billing day.
  • 708: Another process is making changes to the data at this time.
  • 709: No standing orders found to process.
  • json error 710.
  • 711: Standing order does not exist.
  • 712: Amount does not match minimum/maximum, or minimum is greater than maximum.
  • 713: Record status does not allow status update.
  • 714: Invalid Token’s Prefix.
  • 799: Not sent for billing.