Parameters table: structure of documents for withdrawal

Parameters table: structure of documents for withdrawal

.The parameters are optional and appear only if given

Description	Possible value for example	Parameters	.No
Response code to request	0 - successful	ResponseCode	1
Answer code description		Description	2
Total cash shekel	100.50	CashNIS	3
Number of lines in the document		TotalExtReadInvoiceLines	4
Number of lines in the document		TotalExtShvaParams	5
The number of checks in the document		TotalCheque	6
A number of other payment method in the document		TotalCustomPay	7

Document title

Description	Possible value for example	Parameters	.No
Document in honor	0 - successful	ExtReadInvoiceHead.CustName	1
Address line 1		ExtReadInvoiceHead.CustAddresLine1	2
Address line 2		ExtReadInvoiceHead.CustAddresLine2	3
Place		ExtReadInvoiceHead.CustCity	4
Landline		ExtReadInvoiceHead.CustLinePH	5
Mobile Phone		ExtReadInvoiceHead.CustMobilePH	6
Company ID		ExtReadInvoiceHead.CompID	7
Document language	he - Hebrew en - English	ExtReadInvoiceHead.Languge	8
Customer Comments		ExtReadInvoiceHead.Comments	9
Document currency	1 - NIS 2 - DOLLAR Otherwise according to ISO currency list	ExtReadInvoiceHead.CoinID	10
Costumer Email		ExtReadInvoiceHead.Email	11
Send the document to the customer by email?		ExtReadInvoiceHead.SendByEmail	12
Costumer number		ExtReadInvoiceHead.CustomerNumber ExtReadInvoiceHead.AccountId	13
Discount amount		ExtReadInvoiceHead.Discount	14
System Internal Notes		ExtReadInvoiceHead.InternalComments	15
Invoice date		ExtReadInvoiceHead.InvoiceDate	16
Invoice type		ExtReadInvoiceHead.InvoiceType	17
Invoice number		ExtReadInvoiceHead.InvoiceNumber	18
Producing terminal number		ExtReadInvoiceHead.TerminalNumber	19
Total including VAT by document currency		ExtReadInvoiceHead.TotalIncludeVAT	20
Total VAT subject to document currency		ExtReadInvoiceHead.TotalNoVat	21
Total price not subject to VAT by document currency		ExtReadInvoiceHead.TotalVatFree	22
VAT percentage in the document		ExtReadInvoiceHead.VAT	23
The amount of VAT collected by document currency		ExtReadInvoiceHead.VATOnly	24
Total including VAT in shekels		ExtReadInvoiceHead.TotalIncludeVATNIS	25
Total liable for VAT in shekels		ExtReadInvoiceHead.TotalNoVatNIS	26
Total is not subject to VAT in shekels		ExtReadInvoiceHead.TotalVatFreeNIS	27
The amount of VAT collected in shekels		ExtReadInvoiceHead.VATOnlyNIS	28
Currency exchange rate Document to Shekel.		ExtReadInvoiceHead.ISORate	29
Z report number of this document		ExtReadInvoiceHead.ZReport	30
Is a document in open mode?		ExtReadInvoiceLines.TotalLineCostVATOnly	31

Document lines

Description	Possible values for example	Parameters	.No
Cost of line without VAT	500.50	ExtReadInvoiceLines.CostNoVat	1
Item description	Sample item	ExtReadInvoiceLines.Description	2
Total discount	123.12	ExtReadInvoiceLines.Discount	3
Document type		ExtReadInvoiceLines.InvoiceType	4
Line No. in document		ExtReadInvoiceLines.InvoiceLineNum	5
Document number		ExtReadInvoiceLines.InvoiceNumber	6
Line is VAT free?		ExtReadInvoiceLines.IsVatFree	7
'Item code - 'String		ExtReadInvoiceLines.ProductID	8
Amount		ExtReadInvoiceLines.Quantity	9
Total line with VAT		ExtReadInvoiceLines.TotalLineCostIncludeVAT	10
Total line without VAT		ExtReadInvoiceLines.TotalLineCostNoVat	11
Total VAT charged		ExtReadInvoiceLines.TotalLineCostVATOnly	12

:Payment method

:Credit card

:Parameters able - data received by credit company

In addition to the internal data of the CARDCOM billing system, when making a credit debit there are .additional data which are obtained directly from the credit group

:notes

The parameters are transferred only if they exist in the system and the credit companies have been contacted

The parameters are dynamic, additional fields may be added in the future

Description	Possible value for example	Parameters	.No
	According to the code message table 0-300. Caution- there are codes that are different from 0 but still means successful deal!	ExtShvaParams.Status1	1
	Billing codes according to the article: Description of credit card company codes	ExtShvaParams.Sulac25	2
	4580	ExtShvaParams.CardNumber5	3
	0 - Default by credit card company settings. 2 - check only of a review digit 5 - Obtaining approval from the credit companies	ExtShvaParams.JParameter29
	1229	ExtShvaParams.Tokef30	5
	150	ExtShvaParams.Sum36	6
	100	ExtShvaParams.SumStars52	7
	0 - Without approval, receiving the approval number from A.B.S and not from the credit companies because the transaction amount is below the ceiling. Other The approval number received from the credit card companies or the approval number typed when making the transaction.	ExtShvaParams.ApprovalNumber71	8
	50.00	ExtShvaParams.FirstPaymentSum78	9
	20.00	ExtShvaParams.ConstPayment86	10
	!Notice When ExtShvaParams.CreditType63=6 A transaction of 6 payments .will appear 6	ExtShvaParams.NumberOfPayments94	11
	Binding company codes according to the article: Description of credit card company codes	ExtShvaParams.CardTypeCode60
	0 - Private card of an issuing company (PL) 1 - Mastercard 2 - VISA 3 - Maestro 5 - Isracard	ExtShvaParams.Mutag24	13
	Yaniv	ExtShvaParams.CardOwnerName	14
	AA-BB-CC	ExtShvaParams.CardToken	15
	0400000000	ExtShvaParams.CardHolderIdentityNumber	16
	1- Normal 2 - IsraCredit, preferably 30+ 3 - Immediate charge 4 - Club credit 5 - Super Credit 6 - Credit in installments Payments 9 - Club in installments.	ExtShvaParams.CreditType63	17
	0 - Israeli card 1 - Tourist card 2 - gas station card 3 - Immediate debit card 4 - Gift card / rechargeable (except for the card produced by Visa CA at this stage)	ExtShvaParams.AbroadCard119	18
	00 - Blocked card 01 - Ordinary mandatory transaction 02 - Approved mandatory transaction 03 - Forced transaction. 51 - Credit transaction. 52 - Cancellation transaction. 53 - Approved right transaction.	ExtShvaParams.DealType61	19
	00 - Ordinary transaction 01 - Self-service 02 - Self-service at gas stations 05 - contactless 06 - contactless self service 50 - Telephone transaction 51 - Signature transaction only.	ExtShvaParams.ChargType66	20
	1- Shufersal credit card (4580XX44) 2 - hever card 185000000 - 195000000	ExtShvaParams.BinId	21
	123456	ExtShvaParams.InternalDealNumber	22
	12112011	ExtShvaParams.CouponNumber	23
		ExtShvaParams.DealDate	24
		ExtShvaParams.CardOwnerPhone	25

cash:

Description	Possible value for example	Parameters	.No
Total cash in NIS	100.2	CashNIS	1

Checks:

Parameters table: Checks for receipt invoices

Notes:

The class name in Web Server is RciExtCheque and not Check!

You can transfer multiple checks. See an example at the end of the page

Description	Possible value for example	Parameters	No.
Checks number	1324	Cheque.ChequeNumber	1
Bank number	12	Cheque.BankNumber	2
Bank branch number	1	Cheque.SnifNumber	3
Bank account number	132456	Cheque.AccountNumber	4
Check due date	DD/MM/YYYY	Cheque.DateCheque	5
Total check amount	100.50	Cheque.Sum	6

Transfer of multiple checks:

In order to transfer an "array" of checks, the sample checks must be numbered:
First check:

Cheque.ChequeNumber=1234&Cheque.DateCheque=1/10/2011&Cheque.Sum=150.00

Secound check:

Cheque1.ChequeNumber=1234&Cheque1.DateCheque=2/10/2011&Cheque1.Sum=150.00

Third check:

Cheque2.ChequeNumber=1234&Cheque2.DateCheque=3/10/2011&Cheque2.Sum=150.00

other:

Parameters table: Add "other payment" to invoice.

You can add another "payment" method on your invoice. The use of "other payment" is if money is received from another source that is not a credit card, cash or checks such as a bank transfer or receiving a PayPal payment. The account must be set up in the management system before the other payment is transferred in the interface. See: Invoice settings: Various accounts

Note:

The class name in Web Server is RciExtCustome and not CustomPay.

Work in POST Name to Value Use as usual CustomPay.TransactionID according to the table.

You can transfer several payments, see an example at the end of the page.

No.	Parameters	Possible value for example	Description
1	CustomPay.TransactionID	32	A predefined account number in the CARDCOM billing system. See article: Invoice settings: Different accounts. The data must be passed to a runner number.
2	CustomPay.TranDate	31/12/2012	Reference date
3	CustomPay.Description	Receiving payment from PAYPAL	Action Description
4	CustomPay.Asmacta	ZZC-123456	Action reference number
5	CustomPay.Sum	150.00	Total amount

Transfer of "Other Payment" Number:

In order to transfer an "array" of another payment, the number of payments must be numbered:

One other payment:

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

Second other payment:

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

Third other payment:

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

מאמרים בקטגוריית המשנה הזאת

הערות

מאמרים בקטגוריית המשנה הזאת

מאמרים קשורים