Parmeter Name
Type
Format
Description
userName
Input
String
userPass
Input
String
token
Output
String
flag1
Output
String
(values 0 or 1) is for subscription extension period prior to expiration
flag2
Output
String
(values 0 or 1) is for expired subscription
Error codes:
- user not found
- wrong password
- absence blocked
- failed attempts blocked
- general failure
- account blocked
- account not active
Any consecutive request to this API with less than 80ms interval from a previous request will cause a -2000:API busy error.
Example:
https://cloud.tamal.co.il/GetToken/?userName=USER HERE&userPAss=PASSWORD HERE
רשמית חברות - List of companies
למעלה ▲
תאור
יצוא רשימת כל החברות בחשבון המערכת שמוגדרים למשתמש
שם הפונקציה
GetUserCompaniesList
Parmeter Name
Type
Format
CredentialsToken
Input
String
Key
Output
String
Value
Output
String
Example:
https://cloud.tamal.co.il/getusercompanieslist/?credentialstoken= Valid Token Here
פרטי חברה - Company details
למעלה ▲
תאור
Exports All Company data for specified company.
provides an ability to get
whole selected company details
שם הפונקציה
GetCurrentCompanyDetails
Parmeter Name
Type
Format
CredentialsToken
Input
String
ID
Output
Integer
EsekTitle
Output
String
OsekNum
Output
String
OsekTypeCode
Output
Integer
OsekTypeTitle
Output
String
Street
Output
String
HomeNum
Output
String
ZipCode
Output
String
CityCode
Output
Integer
CityName
Output
String
EmailAddress
Output
String
POBNum
Output
String
POBCityCode
Output
Integer
POBCityName
Output
String
POBZipCode
Output
String
KidometPhone1
Output
String
Phone1
Output
String
KidometPhone2
Output
String
Phone2
Output
String
KidometFax
Output
String
Fax
Output
String
BusinessActive
Output
Byte
BusinessTrial
Output
Byte
BusinessInUse
Output
Byte
URL
Output
String
PrimaryAddress
Output
Byte
CurrenciesEnabled
Output
Byte
QuantitiesEnabled
Output
Byte
UnitsEnabled
Output
Byte
ProductLineDiscountEnabled
Output
Byte
RoundingOffDecimalPlaces
Output
Short
ServiceTypeId
Output
Short
ServiceTypeTitle
Output
String
ServicePaidUntil
Output
DateTime
ServicePaidUntilString
Output
String
ApiPaid
Output
Short
Example:
https://cloud.tamal.co.il/GetCurrentCompanyDetails/?credentialstoken= Valid Token Here
Response Error code -1 - could not fetch company details.
תאור
Exports All authorized user details.
שם הפונקציה
GetCurrentUserDetails
Parmeter Name
Type
Format
CredentialsToken
Input
String
CompanyTitle
Output
String
UserName
Output
String
FirstName
Output
String
Lastname
Output
Integer
Email
Output
String
AreaCode
Output
String
PhoneNumber
Output
String
UserType
Output
String
Example:
https://cloud.tamal.co.il/GetCurrentUserDetails/?credentialstoken= Valid Token Here
לקוחות החברה - Company clients
למעלה ▲
תאור
Export All Company clients
שם הפונקציה
GetClientsListMin
Parmeter Name
Type
Format
CredentialsToken
Input
String
CompanyID
Output
Integer
ClientID
Output
Integer
FirstName
Output
String
Lastname
Output
String
AreaCode1
Output
String
Phone1
Output
String
CustomerBalance
Output
Decimal
NotActive
Output
Byte
OsekNum
Output
String
Email
Output
String
Example:
https://cloud.tamal.co.il/GetClientsListMin/?credentialstoken= Valid Token Here
תאור
Exports All data for specified client
שם הפונקציה
GetSingleClient
Parmeter Name
Type
Format
CredentialsToken
Input
String
clientNumber
Input
Integer
ClientID
Output
Integer
CompanyID
Output
Integer
Lastname
Output
String
FirstName
Output
String
Street
Output
String
HomeNumber
Output
String
CityCode
Output
Integer
CityName
Output
String
Response Error code -10 – client not found
Example:
https://cloud.tamal.co.il/GetSingleClient/?credentialstoken= Valid Token Here
מוצרי החברה - Company products
למעלה ▲
תאור
Exports All contacts for specified client.
שם הפונקציה
GetCompanyProductsList
Parmeter Name
Type
Format
CredentialsToken
Input
String
CompanyID
Output
Integer
ProductTypeCode
Output
Short
ProductName
Output
String
ProductDetail
Output
String
ProductMeasurementUnitCode
Output
Short
ProductCurrencyID
Output
Short
ProductUnitPrice
Output
Decimal
ProductMake
Output
String
Example:
https://cloud.tamal.co.il/GetCompanyProductsList/?credentialstoken= Valid Token Here
רשימת בנקים - List of banks
למעלה ▲
תאור
Exports the list of existing Banks in the system
שם הפונקציה
GetBanksList
Parmeter Name
Type
Format
CredentialsToken
Input
String
Example:
https://cloud.tamal.co.il/GetBanksList/?credentialstoken= Valid Token Here
רשימת סניפים - List of branches
למעלה ▲
תאור
Exports the list of existing Bank Branches in the system
שם הפונקציה
GetBankBranchesList
Parmeter Name
Type
Format
CredentialsToken
Input
String
BankBranchCode
Output
Integer
BankBranchName
Output
String
Example:
https://cloud.tamal.co.il/GetBankBranchesList/?credentialstoken= Valid Token Here
חברות כרטיסי אשראי - Credit card companies
למעלה ▲
תאור
Exports the list of existing Credit Card companies in the system
שם הפונקציה
GetCreditCompaniesList
Parmeter Name
Type
Format
CredentialsToken
Input
String
BankBranchName
Output
String
Example:
https://cloud.tamal.co.il/GetCreditCompaniesList/?credentialstoken= Valid Token Here
רשימת מט"ח זמינה - List of available currencies
למעלה ▲
תאור
– Exports the list of existing currencies in the system
שם הפונקציה
GetSupportedCurrenciesList
Parmeter Name
Type
Format
CredentialsToken
Input
String
Example:
https://cloud.tamal.co.il/GetSupportedCurrenciesList/?credentialstoken= Valid Token Here
העתקי מסמכים היוצר - Produced document copies
למעלה ▲
תאור
– Exports the list of existing currencies in the system
שם הפונקציה
GetDocCopies
Parmeter Name
Type
Format
Description
CredentialsToken
Input
String
DocumentType
Output
Integer
100, 300, 305, 320, 330,
400, 405, 10100, 10301
DateFrom
Output
String
Short
DateFrom
Input
dd-MM-yyyy
Short
DateTo
Input
dd-MM-yyyy
Short
ClientId
Input
Integer
Optional parameter
If client not exists –
error code – 1004
AmountFrom
Input
Decimal
Optional parameter
AmountTo
Input
Decimal
Optional parameter
TopResults
Input
Integer
Optional parameterDefault value is 25,
Possible parameters (25,50,100,1000,5000)
SortOrder
Input
String
Optional parameterDefault value is 'asc', Possible parameters ('asc', 'desc')
OrderBy
Input
String
Optional parameterDefault value is 0Possible parameters
(0 – client name1 – document type2 – document number3- date4 – amount)
CustomerNumber
Output
Integer
DocumentTypeCode
Output
Short
DocumentTypeTitle
Output
String
DocProducedDateConv
Output
String
DocumentDetail
Output
String
DocumentTotal
Output
Decimal
DocumentClosed
Output
Short
DocumentNumber
Output
Short
Example:
https://cloud.tamal.co.il/GetDocCopies/?credentialstoken= Valid Token Here
נתוני מסמך מיוצרים - Produced document data
למעלה ▲
תאור
Exports document data according to the specified document
שם הפונקציה
GetDocument
Parmeter Name
Type
Format
Description
CredentialsToken
Input
String
DocumentType
Input
Integer
100, 300, 305, 320, 330,
400, 405, 10100, 10301
DocumentNumber
Input
Integer
ClientNumber
Output
Integer
ClientAddress
Output
String
ClientCityZip
Output
String
ClientOsekNum
Output
String
ProducedDate
Output
DateTime
ProducedDateString
Output
String
SumBeforeDiscount
Output
Decimal
DiscountAmount
Output
Decimal
DiscountPercentage
Output
Decimal
TotalBeforeMaam
Output
Decimal
DocMaamAmount
Output
Decimal
DocTotalDue
Output
Decimal
DocNikuyBamakorSum
Output
Decimal
DocUserFullName
Output
String
GeneralRemark
Output
String
DocTypeRemark
Output
String
DocProductsXML
Output
String
DocChargesXML
Output
String
DocClosureXML
Output
String
DocIsSourceProduced
Output
Byte
SourceTypeCode
Output
Short
SourceDocNumber
Output
Integer
Response Error code -10 - document not found
Example:
https://cloud.tamal.co.il/GetDocument/?credentialstoken= Valid Token Here
שאילתה למסמך - Inquery for a document
למעלה ▲
תאור
Exports document data according to the specified document
שם הפונקציה
GetLoggedResponseByClientIdentifier
Parmeter Name
Type
Format
CredentialsToken
Input
String
clientIdentifier
Input
String
Response Error codes:
1 – Bad or missing clientIdentifier
2 – Nothing found
3 – Multiple entries found
4 – Log currently inaccessible
Example:
https://cloud.tamal.co.il/GetLoggedResponseByClientIdentifier/?credentialstoken= Valid Token Here