Direct Client Entity Access

The function Direct_Client_Entity_Json provide access to a client's data VIA read or write modes.
The client's data is based of the following 6 DB tables:
To enable, 'Direct Access API into Hyper' must be included in 'Website Features' setting.

Read Client Data

Activating this function in read mode, retrieves all the client's data from all of the 6 tables listed above.
To read the data just call the function with the parameters: "ClientNumber" and "API_Password". here is an example.

Function Input:
{
  "ClientNumber":500608,
  "API_Password":"8Lba7u5smGR7" ; 12 ansi chars (abc + digits)
}

Function Output:
{
  "ResponseCode":0,
  "FunctionName":"Direct_Client_Entity_Json",

  "Client_Rec":{
    "ClientNumber":500608,
    "Agency":0,
    "Title":"",
    "LastName":"חברה לניסיון בע\"מ",
    "FirstName":"",
    "3rdOptionalName":"",
    "ClientFullName":"חברה לניסיון בע\"מ",
    "Email":"demo@company.co.il",
    "WebPage":"",
    "1stPhone":"03-126-4567",
    "2ndPhone":"",
    "3rdPhone":"",
    "Fax":"",
    "VoipPhone":"",
    "StreetAddress":"ויצמן 1",
    "City":"תל אביב",
    "Region":"",
    "Country":"ישראל",
    "ZipCode":"",
    "BuildingApartmentOfficeInstructions":"",
    "UseADifferentMailingAddress":"",
    "Gender":3,
    "Birthday":"",
    "IdNumber":"5165498712",
    "IdDocType":0,
    "IdDocValidUntil":"",
    "CountryIssuingId":"",
    "DocsFormsLanguage":0,
    "HandlingStatus":0,
    "TitleInEnglish":"",
    "LastNameInEnglish":"",
    "FirstNameInEnglish":"",
    "IdNumber2":"",
    "IdDocType2":0,
    "IdDocValidUntil2":"",
    "CountryIssuingId2":"",
    "CreatedOn":"2023-09-03 18:54:58",
    "CreatedBy":"SYE Shlomi Ronen",
    "ParentClientAccount":0,
    "ParentClientAccountName":"",
    "AssignJournalEntriesToParent":0,
    "MiddlemanAccount":0,
    "MiddlemanName":"",
    "MiddlemanContactPerson":"",
    "UseCurrencyByDefault":"ILS",
    "CommittedToPayVat":1,
    "ProduceInternationalDocumentsByDefault":0,
    "SendOfficialDocumentsToPrimaryEmail":0,
    "PreventSendingPrintingOfTheFollowing":"",
    "DefaultPaymentTerms":0,
    "CreditMonths":0,
    "CreditDays":0,
    "ExportAccountTo3rdParty":0,
    "GovTaxAuthoritiesId":"",
    "MoneyLaundering":0,
    "SecRegulation":0,
    "IndustryClassificationCode":0,
    "IndustryClassification":"",
    "GisLatitude":0,
    "GisLongitude":0,
    "DataSource":"",
    "RoleForLoanModule":0,
    "DefaultSalesAgent":"",
    "DefaultRelationshipManager":"",
    "SpareAgent1":"",
    "SpareAgent2":"",
    "SpareAgent3":"",
    "PriceList":"",
    "AcceptCommercialInfoToCellPhone":"",
    "QuestionToUseCellPhone":0,
    "AcceptCommercialInfoToEmail":"",
    "QuestionToUseEmail":0,
    "RelationshipAbstract":"",
    "LastPhoneCallOn":"",
    "LastPhoneCallBy":"",
    "LastPhoneCallTryToCallResult":0,
    "NextPhoneCallOn":"",
    "NextPhoneCallBy":"",
    "LastContactOn":"",
    "LastMeetingOn":"",
    "FirstMeetingOn":"",
    "FirstProposalQuotationOn":"",
    "ClientApprovalDate":"",
    "FirstTransactionDate":"",
    "LastTransactionDate":"",
    "MandatoryDocuments":0,
    "ReviewStatus":0,
    "LeadSupplier":"",
    "LeadStatus":0,
    "LastLeadInput":"",
    "NotInterestedReason":0,
    "AssignedByWizardOn":"",
    "AlertOpenPositionsBeyond":0,
    "AlertCollateralRequirementBeyond":0
  },

  "Client_Ext_Rec":{
  },

  "Contact_Persons":[
    {
      "CreatedOn":"2023-09-03 18:56:39",
      "AgencyDivisionName":"",
      "Title":"",
      "LastName":"רונן",
      "FirstName":"שלומי",
      "3rdOptionalName":"",
      "ContactFullName":"שלומי רונן",
      "Email":"shlomo@shlomi.co.il",
      "WebPage":"",
      "1stPhone":"052-400-0123",
      "2ndPhone":"",
      "3rdPhone":"",
      "Fax":"",
      "VoipPhone":"",
      "StreetAddress":"גינת אגוז",
      "City":"פרדס חנה",
      "Region":"",
      "Country":"ישראל",
      "ZipCode":"",
      "BuildingApartmentOfficeInstructions":"",
      "UseADifferentMailingAddress":"",
      "Gender":1,
      "Birthday":"",
      "IdNumber":"035698141",
      "IdDocType":0,
      "IdDocValidUntil":"",
      "CountryIssuingId":"",
      "TitleInEnglish":"",
      "LastNameInEnglish":"",
      "FirstNameInEnglish":"",
      "IdNumber2":"",
      "IdDocType2":0,
      "IdDocValidUntil2":"",
      "CountryIssuingId2":"",
      "LegalStatusRole":"בעל שליטה בתאגיד",
      "AuthorizedSignatory":1,
      "AllowToReceiveOfficialDocuments":1,
      "Former-Disabled":0,
      "AcceptCommercialInfoToCellPhone":"",
      "QuestionToUseCellPhone":0,
      "AcceptCommercialInfoToEmail":"",
      "QuestionToUseEmail":0,
      "PartnershipHyperClientAccount":0,
      "PercentageOfPartnershipInThisAccount":0
    }
  ],

  "CC_Banking":[
    {
      "CreatedOn":"2023-09-03 15:58:59",
      "PaymentMethod":2,
      "DefaultForAutomaticMonetaryTransactions":1,
      "AllowToBeUsedByWebsiteApi":0,
      "BankCode":"11",
      "BranchSwift":"40",
      "Account":"616494",
      "BankTransferPaymentFormat":0,
      "RegBankCountry":"ישראל",
      "RegBankName":"בנק דיסקונט לישראל בע\"מ, רמת גן",
      "RegBankAddress":"הרצל 50 רמת גן",
      "RegAccountOwnerAsContactPerson":"",
      "CcLast4Digits":"",
      "ShortDescription":"מאושר למס\"ב",
      "RequestedPaymentDayMonthly":0,
      "LastUsage":"",
      "LastUpdate":"2023-09-03 18:59:10",
      "EntityFullName":"חברה לניסיון בע\"מ"
    }
  ],

  "Monthly_Billing":[
    {
      "CommitmentId":1,
      "ServiceStartedFrom":"2023-01-01",
      "ServiceEndsAt":"",
      "CatalogicNumber":"Human_User",
      "Description":"מנוי חודשי לרישיון שימוש בתוכנת הייפר, למשתמש אנושי",
      "UnitOfMeasure":4,
      "Tax-freeSalePrice":0,
      "TaxableSalePrice":127,
      "SalePriceMethod":0,
      "FinalSalePrice":0.00,
      "SaleCurrency":"ILS",
      "Logic":0,
      "LastBillingDate":"",
      "Notes":"",
      "LastUpdate":"2023-09-03 19:00:00",
      "UpdatedBy":"SYE Shlomi Ronen"
    }
  ],

  "Website_Rec":{
  }
}

Update Client Data

To update specific fields from the 6 tables above, call the function with: "ClientNumber" and "API_Password" and provide the json Objects for the tables you wish to update.

Important Note:
Sending empty parameters will cause existing data to be erased!
to bypass this issue add the parameter: "SkipEmptyValues":1 to the function, to ensure that empty parameters won't erase existing data.

Here is an example for 3 tasks at once:
  • update "2nd Phone" field of the main client record.
  • Update "3rd Optional Name" field of the first contact person.
  • Add a new contact person. This is a low level method, so it does not search for dups or mandatory fields !

{
  "ClientNumber":500608,
  "API_Password":"12 ansi chars",
  "SkipEmptyValues":1,

  "Client_Rec":{
    "2ndPhone":"097406666"
  },

  "Contact_Persons":[
    {
      "ItemIndex":0,
      "3rdOptionalName":"ניסיון"
    },
    { not using ItemIndex in order to add a new person record to the table
      "Title":"",
      "LastName":"איש קשר",
      "FirstName":"נוסף",
      "3rdOptionalName":"",
      "Email":"somebody@gmail.com",
      "WebPage":"",
      "1stPhone":"0528765432",
      "2ndPhone":"",
      "3rdPhone":""
    },
  ]
}

Function Input:
Field Description
ClientNumber The client entity that you with to update.
API_Password For data security, every client has a unique password for HTML and API access.
IF you need to cancel this feature, please Register a value "Web-API Password"="Disabled" in the "Extended App Settings" window.
SkipEmptyValues When you need to pass all fields anyway, and want Hyper to SKIP empty string or Zeroed values.
Otherwise, any field that was passed on the json object, will override the value on Hyper.
ItemIndex In order to update a record IN ARRAY object, add this field, first array item (record) is Zero.
When not using "ItemIndex" or "DeleteItemIndex", Hyper will ADD a new record to the table.
DeleteItemIndex In order to DELETE a record from an ARRAY object.
AddItem:PreventDup Post this parameter (flag) when adding new record/s to one of the following tables:
hyp_Client Contacts
hyp_Entity_Banking_and_Credit_Cards
hyp_Client Monthly Billing for Services
This flag will tell the system to check the existing records and prevent the creation of duplicated ones.

DON'T USE THIS FLAG WITH "ItmeIndex"!

in depth explanation:
  • A "hyp_Client Contacts" (contact person) duplicity is when one of the fields: "Email" OR "1st Phone" OR "2nd Phone" OR "ID Number" OR "ID Number 2" contain data and are equal to an existing record in the DB.
  • A "hyp_Entity_Banking_and_Credit_Cards" (payment method) duplicity is when all of the fields: "Payment Method" AND "Bank Code" AND "Branch / Swift" AND "Account" AND "Encrypted Data", are equal to an existing record in the DB.
  • A "hyp_Client Monthly Billing for Services" duplicity is when all of the fields: "Catalogic Number" AND "Description" AND "Quantity" AND "Net Sale Price" AND "Gross Sale Price", are equal to an existing record in the DB.
Then, the existing record will be deleted and replaced by the new posted one.

Function Output:
{
  "ResponseCode":0,
  "ResponseMsgEng":"Database was updated successfully",
  "FunctionName":"Direct_Client_Entity_Json",
// At this point all 6 tables are exported just like in the demo above.
}