Receipt (Deposit) Doc API

This guide explains how to generate a new receipt document by calling the Create_Receipt_Json function.
The function receives a JSON data structure with document header fields and an [Items] array that contains the receipt method lines.
After validation, the system produces the original receipt document, creates journal entries and cash-management rows when relevant, and returns the generated receipt header record in the Doc object.

JSON Structure Example for Receipt Creation

{
  "ClientNumber": 500608,
  "API_Password": "8Lba7u5smABC"
  "Ticket_ID": "REQ-998877",
  "InternalDoc_Dont_Send": true,
  "SalesAgent": "Dani",
  "Notes": "Webpage id 1234",
  "ReceiptFormPurpose": 1,
  "Items": [
    {
      "PaymentMethod": 2,
      "PaymentDate": "2026-04-26",
      "TotalAmount": 1500.0,
      "Currency": "ILS",
      "BankCode": "12",
      "BranchSwift": "001",
      "Account": "123456",
      "BankTransferPaymentFormat": 0,
      "IntoInternalAccount": 1100
    }
  ]
}

Document Header Fields

These fields should be passed at the root level of the JSON object.
Fields defined as mandatory are marked accordingly.
JSON Field Name Data Type Description
ClientNumber Integer Client number in Hyper (Mandatory Field). Must be defined in the system.
Ticket_ID String Service ticket number or internal reference to prevent duplicates.
InternalDoc_Dont_Send Boolean Whether to prevent sending a signed digital document to the client. Setting to true marks the receipt as "Do not distribute".
PersonalIdVerificationMadeBy String Client identity verified by. Must pass a valid username existing in Hyper.
SalesAgent String Sales agent associated with the receipt (Username).
Notes String General notes that will appear on the receipt.
IPAddress String IP address from which the action was performed (for control purposes).
OriginProductionTime DateTime (Double) Original production time. Allows overriding the receipt creation date if there is a historical need.
ContactPerson String Name of the relevant contact person for the receipt from the client record.
Agency Status (Integer) The branch to which the receipt will be associated.
ReceiptFormPurpose Enum (Integer) Purpose of the receipt form.
0 = Retail Payment
1 = Deposit to Account
2 = Loan Repayment
3 = Property Exchange Service
MoneyLaundering Enum (Integer) AML (Anti-Money Laundering) control level definition for the document.
0 = Normal
1 = Report Anyway
2 = DO NOT Report
MoneyLaunderingBundle Integer AML document bundle number.

Receipt Items Array

These rows must be passed within the [Items] array at the root level.
Field Name (in Items array) Data Type Description
PaymentMethod Enum (Integer) Payment method (Mandatory Field).
0 = Cash
1 = Credit Card
2 = Bank Transfer
3 = Cheque
4 = Security Bill
5 = Assignment of Rights
6 = Deduction at Source
7 = Bill of Exchange
8 = Traveller Check
9 = E.Wallet
PaymentDate Date Repayment date (Mandatory Field). The date the funds become available.
TotalAmount Double Line receipt amount (Mandatory Field). Must be greater than 0.1.
Currency String Payment currency (Mandatory Field).
ExchangeRate Double Exchange rate. If 0 is entered, the system will auto-complete the representative rate for that date.
MonthlyPayments Integer Number of monthly payments (relevant for credit payments).
FirstPaymentAmount Double Amount of the first payment in a credit plan.
NextPaymentsAmount Double Amount of subsequent payments in a credit plan.
AdvancedPaymentSys Enum (Integer) Credit transaction definition (special payments).
0 = No
1 = External Credit
2 = +30 Days
BankCode String Bank code (for cheques and bank transfers).
BranchSwift String Bank branch or Swift code.
Account String Paying account number.
BankTransferPaymentFormat Enum (Integer) Bank transfer format.
  1. unknown (local)
  2. Swift + IBAN
  3. SEPA + IBAN
  4. Swift + BSB
  5. ABA (US)
  6. Swift + CNAPS
  7. Swift Hong Kong
  8. Swift + IBAN + UK sort
ChequeCcNumber String Cheque number or last 4 digits of the credit card.
ClearingCompany String Transaction clearer / clearing company through which the transaction passed.
CcEwBrand String Cleared brand (credit card or e-wallet).
ClearingVoucher String Official clearing voucher / confirmation number.
RegReceivedFromCountry String Country from which the money was received (AML / Regulation).
RegBankName String Registered bank name of the paying entity (AML / Regulation).
RegBankAddress String Registered bank address (AML / Regulation).
RegAccountOwnerAsContactPerson String Payer as contact person, in case the beneficiary is not the client (AML / Regulation).
IntoInternalAccount Integer Enters into account number (internal deposit account identification in the system).

Function output

When it succeed, it return the whole receipt header record: 
// Function output
{
  "ResponseCode":0,
  "ResponseMsgEng":"Success",
  "Doc":{
    "ReceiptNumber":65619,
    "Agency":0,
    "DrawerStationId":0,
    "SalesAgent":"",
    "ClientNumber":512584,
    "ClientFullName":"לקוח 512584",
    "ContactPerson":"",
    "Address":"24 sesame st. Tel aviv",
    "Phone":"03-1234567",
    "Email":"cookie@monster.com",
    "IdNumber":"987654321",
    "Language":1,
    "InternationalDocument":0,
    "TotalAmountLc":1500.00,
    "PurchaserCurrency":"ILS",
    "TotalAmountInPc":1500.00,
    "OriginProductionTime":"2026-04-26 10:07:41",
    "CreatedOnUtc":"2026-04-26 07:07:41",
    "ProducedBy":"Dev4_website",
    "ElectronicSignedPdf":3,
    "Notes":"Webpage id 1234",
    "InternalNotes":"REQ-998877",
    "AccountCountryCode":"IL",
    "ReceiptFormPurpose":1,
    "MoneyLaundering":0,
    "MoneyLaunderingBundle":0,
    "PersonalIdVerificationMadeBy":"Online SelfService",
    "IpAddress":"",
    "ResponsibleManager":"",
    "OldDocReference":"",
    "OldSoftwareName":"",
    "CancellationTime":"",
    "CancelledBy":"",
    "CancellationReason":"",
    "AccountBalanceAtProductionTime":0.00,
    "CreditLineUsageRiskLc":0,
    "ReceiptCollectionTargetLc":0.00
  }
}

// Function output on error, custom text messages to the same codes list
{
  "ResponseCode":5,
  "ResponseMsgEng":"Logical error: Init_Sales_Doc_Header failed"
}