Field Limits
These rules apply to every import endpoint. Each endpoint page lists the type and maximum length of its fields; this page explains which characters are accepted, what happens when a value breaks a rule, and how text and number fields are handled.
Character encoding
Company data is stored in ISO-8859-8 (MySQL charset hebrew). Text fields accept only the characters in that code page.
Accepted
- All ASCII: English letters, digits, punctuation, straight quotes
'", hyphen- - The 27 Hebrew letters ת–א
- These symbols: ¢ £ ¤ ¥ ¦ § ¨ © « ¬ ® ° ± ² ³ ´ µ ¶ · ¸ ¹ » ¼ ½ ¾ × ÷
Rejected, and what to send instead
| Character | Name | Send instead |
|---|---|---|
| ₪ | Shekel sign | ח"ש or NIS |
| ״ ׳ | Hebrew geresh, gershayim | ' " |
| ־ | Hebrew maqaf | - |
| ‘ ’ “ ” | Curly quotes | ' " |
| – — | En dash, em dash | - |
| … | Ellipsis | ... |
| • | Bullet | - or * |
| € ™ | Euro sign, trade mark | EUR TM |
| é ü ñ ç ø ß | Latin letters with accents or special forms | The plain letter: e u n c o ss |
| Greek, Cyrillic, Arabic, Chinese, … | Any script other than Latin and Hebrew | A transliteration in Latin or Hebrew letters |
| 😀 | Emoji | Remove |
| שׁ בּ אָ | Hebrew vowel points (nikud) and cantillation marks | Remove before sending |
Text copied from Word, Outlook or a web page often contains curly quotes, long dashes and the Hebrew gershayim, which look almost identical to the plain characters. Normalise text before sending it.
What happens to nikud and rejected characters
| Endpoint | Nikud | Any other rejected character |
|---|---|---|
| All import endpoints: documents, receipts, journal, indexes, extra data, company definition, sort codes, trans types, bank statements, CRM, files | Not removed: the request fails | The request fails with the database error Incorrect string value, which does not name the field. |
- Only fields the API stores are checked. A field the API does not recognise is ignored, even if it contains an emoji.
- Email fields are never modified. Nikud or any other rejected character in an email address returns an error.
createInvReceiptcreates the temporary invoice before it checks the payment section. If a payment field contains a rejected character, the temporary invoice is removed only whenmain_infocontains"deleteTemp": true.- Apart from removing nikud, a value is never changed or shortened.
Text fields
- The maximum length on each endpoint page is in characters. A Hebrew letter counts as one character.
- A value longer than the maximum is rejected. It is not shortened.
- Spaces:
- Journal, index, extra data, sort code, trans type and bank statement imports remove leading and trailing spaces before checking the length.
- Documents, receipts and company definition save text as sent. Leading and trailing spaces count toward the maximum length.
Integer fields
Fields typed Integer number are stored as 32-bit integers. This includes every reference field: Referance, Ref2, Ref3, Reference, ref, DocNumber, cheqnumber.
- Send a whole number made of digits only. Letters, spaces, hyphens, slashes and decimal points are not accepted.
- The maximum value is 2,147,483,647 (10 digits).
- Send a value of 0 or more.
- Leading zeros are not kept:
00123is saved as123.
A reference that contains letters, separators or leading zeros, such as INV-0015 or 2024/15, cannot go in a reference field. Send the number part in the reference field and the full reference in a text field such as Details.
Amounts and quantities
- Send amounts as plain numbers with a dot as the decimal separator, without thousands separators or currency signs:
1234.50, not1,234.50or₪1234.50. - Journal and index imports accept up to 24 characters per amount or quantity.
- Documents limit some numbers by digits. The limit is listed per field on the Import Documents page, for example Price and Quantity up to 14 digits.