Parameters table for creating invoice:
This article show all the required parameters that need to be transferred in order to create an Invoice when clearance action.
Remarks:
- The parameters need to be added in the same billing request.
- The total amount of the invoice lines must be equal to the amount of billing in the billing request.
- The amount summary of line in the invoice is price per unit multiplied by the quantity of units.
- Required fields are marked in red.
- There is an example at the bottom of this article on how to pass number of lines to the request with 'https post'
- When using web service the classes to use are :
InvExtHead : The head of the invoice.
InvExtHeadLines : The lines of the invoice.
- All the transferred parameters values need to be urlencode.
- when using 'http post' an extra parameter is required 'codepage=65001' which determine the UNICODE of the hebrew values
Parameters table of the Invoice header:
Parameter |
Description |
Examples values |
InvoiceHead.CustName |
Customer name on the invoice |
yaniv |
InvoiceHead.SendByEmail |
tall BillGold system if to send the invoice to the customer |
true |
InvoiceHead.Language |
Invoice language |
he - Hebrew en - English |
InvoiceHead.Email |
Email address where the invoice will be send to |
yaniv@site.com |
InvoiceHead.CustAddresLine1 |
Customer address, First line |
Saharov 22 |
InvoiceHead.CustAddresLine2 |
Customer address, Second line |
P.O. 1234 |
InvoiceHead.CustCity |
City |
Reshin-Le-Zion |
InvoiceHead.CustLinePH |
Phone number |
972-3-9619611 |
InvoiceHead.CustMobilePH |
Cellular number |
0549876543 |
InvoiceHead.CompID |
unique company id |
040617640 |
InvoiceHead.Comments |
Invoice Comments - will be printed on the invoice |
|
InvoiceHead.CoinID |
Invoice currency Applies only when using Invoice with no charge, when using Invoice with charge the currency will be determined by the credit billing
|
1- NIS 2 - US Dollar All the currencies which defined in the system |
InvoiceHead.ExtIsVatFree |
determine id the invoice without VAT - suited for customer from overseas |
false |
InvoiceHead.ManualInvoiceNumber |
Manual counting of invoice, can only be used when creating invoice without charge Special permission is required in order to use this. Read remarked at the bottom |
|
Parameters table of the invoice line (products):
Parameter |
Description |
Examples values |
InvoiceLines.Description |
Product description |
Intel Computer |
InvoiceLines.Price |
Unit price of product |
1559 |
InvoiceLines.Quantity
|
Unit quantity |
1 |
|
|
|
InvoiceLines.ProductID |
Product code - recommended for creating reports |
ZZASA AASSA - 12 |
InvoiceLines.IsVatFree
|
- Allows mix products with VAT and without in one invoice.
in most cases the price is with VAT.
- in case that the invoice is without VAT at all use InvoiceHead.ExtIsVatFree for the invoice head.
|
false true |
Remarks :
1.The parameter ManualInvoiceNumber :
In very rare cases invoice number can be determined instead of using the internal counter of the system.
Notice: in case of collision of the system counter and the manual counter the invoice will not be created
Notice: special permission is required in order to use this.
HTTPS POST example for creating invoice with couple of lines
Attention: In order to create more than one line serialize the postfix of the parameter InvoiceLines.Description like InvoiceLines1.Description / InvoiceLines2.Description
Parameters for the head of the invoice :
InvoiceHead.CustName=Yaniv&InvoiceHead.Languge=he&InvoiceHead.CoinID=1&InvoiceHead.Email=test@gmail.com
InvoiceLines1.Description=Item2&InvoiceLines1.Price=200.50&InvoiceLines1.Quantity=2
Parameters for the second line in the invoice :
InvoiceLines2.Description=Item3&InvoiceLines2.Price=100&InvoiceLines2.Quantity=3