Creating invoice via API

This article will explain how to create invoice without credit card charge.
this is also useful for creating an invoice for a payment you received via bank transfer, BIT App, cash, etc...

Stages of process

to create an invoice you need contact the CARDCOM server and send the matching parameters.
the parameters divide into 3 groups:

1. parameters for client details and invoice type
2. invoice details - includes headline and rows
3. method of payment. examples: cash, cheque, CC, bank transfer etc...

Key
Red parameter - must
bold parameter - recomended
not red or bold - optional

function NAME TO VALUE address: https://secure.cardcom.solutions/Interface/CreateInvoice.aspx

Parameter request table

No	Parameter	possible values for example	Description
Parameters for customer identification and the type of document to be produced
1	terminalnumber	1000	Internal terminal number (not shava)
2	username	TestUser	user name
3	InvoiceType	1- receipt tax invoice 2 - receipt tax credit invoice 3 - vat free receipt 4 - vat free credit receipt 50- price quote 100 - order 101 - site order  confirmation 102 - site order  confirmation- credit 200 - consignment note (210 - return note) 300 - Proforma Invoice 301 -   Payment request 302 cancel payment request 305 - Tax invoice 330 -  Tax credit invoice 400 - receipt for tax invoice  410 -  credit receipt for tax invoice) 405 - donation receipt 406 - credit donation receipt	invoice type. if you are trying to charge CC use parameter DocTypeToCreate instead https://secure.cardcom.solutions/Interface/LowProfile.aspx
Invoice details - document title
4	InvoiceHead.CustName	Eli Cohen LTD	Client/Company name that appears on the invoice
5	InvoiceHead.SendByEmail	true	send/not send invoice via mail, if send - add email address
6	InvoiceHead.Language	he - hebrew en - english	Invoice Language
7	InvoiceHead.Email	[e-mail]	client email address
8	InvoiceHead.CustAddresLine1	Saharov 22	client physical address
9	InvoiceHead.CustAddresLine2	P.O. 1234	client physical address
10	InvoiceHead.CustCity	Rishon-Le-Zion	client city
11	InvoiceHead.CustLinePH	03-9619611	client landline
12	InvoiceHead.CustMobilePH	0549876543	client  cell phone
13	InvoiceHead.CompID	040617640	company ID
14	InvoiceHead.Comments	example: 1 year warranty	invoice notes and comments
15	InvoiceHead.CoinID	1- NIS  2 - USD  978 - EUR Full list here	invoice coin parameter
16	InvoiceHead.ExtIsVatFree	true = VAT free	apply for VAT free invoice
17	InvoiceHead.ManualInvoiceNumber		manual number for invoice - needs special permit - see notes at the bottom of the article
18	InvoiceHead.IsAutoCreateUpdateAccount	false - everyone will be listed under "occasional clients" true - cardcom interface will open a client card index	if true - you must use parameter InvoiceHead.CompID
19	InvoiceHead.AccountForeignKey	1234 (String)	foreign key for bookkeeping purposes
20	InvoiceHead.InvDate	dd/MM/yyyy	invoice date - you can produce an invoice up to 14 days backwards max - by law.
21	InvoiceHead.DepartmentId	123  (int)	Department Id - for bookkeeping purposes
22	InvoiceHead.SiteUniqueId	(String)	Site Unique Id
23	InvoiceHead.AccountID	(int) 123	Account ID
24	InvoiceHead.ValueDate	dd/MM/yyyy	Value Date
25	InvoiceHead.ExternalId	(String)	External Id
26	InvoiceHead.IsLoadInfoFromAccountID	true	only in manual production - Load Info From Account ID
The details of the invoices - the lines of the document
27	InvoiceLines.Description	online course	Description
28	InvoiceLines.Price	1	Price
29	InvoiceLines.Quantity	1	the number of items, When transferring a quantity over 1, you must double the price and send an appropriate payment method.
30	InvoiceLines.ProductID	ZZASA AASSA - 12	Product ID
31	InvoiceLines.IsVatFree	true\false	enables a mixture of vat included and vat free products in the same invoice

parameters for first invoice line:

InvoiceLines 1 .Description=Item1&InvoiceLines 1 .Price=200.50&InvoiceLines 1 .Quantity=2

parameters for second invoice line:

InvoiceLines 2 .Description=Item2&InvoiceLines 2 .Price=200.50&InvoiceLines 2 .Quantity=2

parameters for third invoice line:

InvoiceLines 3 .Description=Item3&InvoiceLines 3 .Price=100&InvoiceLines 3 .Quantity=3

must not string not allowed symbols like:  & ;

*in case of tenth of a number - use first two digits
*it is possible to create a discount line using (-) but make sure that the amount after discounts fits the transaction amount

Method of payment:

Cash

No	parameter	possible values for example	description
1	cash	50.30	amount paid in cash

Cheques 

No	parameter	possible values for example	description
1	Cheque.ChequeNumber	1234	Cheque Number
2	Cheque.BankNumber	12	Bank Number
3	Cheque.SnifNumber	1	Bank branch number
4	Cheque.AccountNumber	123456	Account Number
5	Cheque.DateCheque	dd/MM/yyyy	Date of Cheque
6	Cheque.Sum	100.50	Cheque sum

Stringing multiple Cheques:

first one: Cheque.ChequeNumber=123&Cheque.DateCheque=1/2/2011&Cheque.Sum=150.00
second one: Cheque1.ChequeNumber=123&Cheque1.DateCheque=2/2/2011&Cheque1.Sum=150.00
third one:  Cheque2.ChequeNumber=123&Cheque2.DateCheque=3/2/2011&Cheque2.Sum=150.00


Credit card - crossing invoice to a transaction

1. only cross invoice to a transaction that doesnt already has an invoice crossed to - otherwise the invoice production will fail.
2. credit invoice to credit transactions, charge invoice to charge tranascions.
3. the parameter in WEB SERVICE is called RciExtDealNum

No	parameter	possible values for example	description
1	CreditDealNum.DealNumber	14214 (InternalDealNumber )	Internal Deal Number

Other payment method
example: bank transfer, BIT App, Paypal...
first you need to create the payment method in the Cardcom interface

No	parameter	possible values for example	description
1	CustomPay.TransactionID	32	bookkeeping number
2	CustomPay.TranDate	31/12/2012	transaction date
3	CustomPay.Description	bank transfer payment	payment description
4	CustomPay.Asmacta	123456-ZZC	Asmacta ID
5	CustomPay.Sum	150.00	Sum total

Example of stringing Other payment methods

first Other payment method:

CustomPay.TransactionID=31&CustomPay.TranDate=31/12/2011&CustomPay.Asmacta=ZZ123&CustomPay.Sum=150

second Other payment method:

CustomPay1.TransactionID=31&CustomPay1.TranDate=31/11/2011&CustomPay1.Asmacta=ZZ123&CustomPay1.Sum=150

third Other payment method:

CustomPay2.TransactionID=31&CustomPay2.TranDate=31/10/2011&CustomPay2.Asmacta=ZZ123&CustomPay2.Sum=150

Table of parameters - response

No	parameter	possible values for example	description
1	ResponseCode	0 - valid  any other - error	response code
2	Description	valid	description
3	InvoiceNumber	9871	Invoice Number
4		1- receipt tax invoice 2 - receipt tax credit invoice 3 - vat free receipt 4 - vat free credit receipt 50- price quote 100 - order 101 - site order  confirmation 102 - site order  confirmation- credit 200 - consignment note (210 - return note) 300 - Proforma Invoice 301 -   Payment request 302 cancel payment request 305 - Tax invoice 330 -  Tax credit invoice 400 - receipt for tax invoice  410 -  credit receipt for tax invoice) 405 - donation receipt 406 - credit donation receipt	Invoice Type

Download example code ↓

• CreateInvoice.php.txt