Data reference
The following sections describe the different data types used by the endeve API.
CONTACTS
| Attribute | Data type | Description |
|---|---|---|
| account-id | Integer | Your account unique identifier. Read only attribute. |
| address | String (Max. length: 255) | Contact postal address. |
| bank-account-number | String (Max. length: 255) | Contact bank account number. Fixed length: 20 caracters. |
| city | String (Max. length: 255) | Contact city. |
| contact-person | String (Max. length: 255) | Contact person in the company |
| created-at | DateTime | Contact creation date. Read only attribute. |
| delivery-address | String (Max. length: 255) | Contact deliver postal address. |
| delivery-city | String (Max. length: 255) | Contact deliver city. |
| delivery-phone1 | String (Max. length: 255) | Contact deliver main phone. |
| delivery-phone2 | String (Max. length: 255) | Contact deliver secondary phone. |
| delivery-postal-code | String (Max. length: 5) | Contact deliver postal code. |
| delivery-region-id | Integer | Contact region identifier. It cannot be null. |
| discount-rate | Float (Precision: 2) | Discount applied by default to sale items for this contact. |
| String (Max. length: 255) | Contact email address. You can specify more than one address separating it by commas. | |
| fax | String (Max. length: 255) | Contact fax. |
| first-name | String (Max. length: 255) | Contact Name or Corporate name |
| id | Integer | Contact unique identifier. |
| language-id | Integer | Language unique identifier. It cannot be null. |
| last-name | String (Max. length: 255) | Contact last name (if exists). |
| notes | String (Max. length: 255) | Notes about the contact. |
| phone1 | String (Max. length: 255) | Contact main phone. |
| phone2 | String (Max. length: 255) | Contact secondary phone. |
| postal-code | String (Max. length: 5) | Contact postal code. |
| region-id | Integer | Contact region unique identifier. |
| sales-count | Integer | Number of sales issued to this contact. By default: 0 |
| updated-at | Datetime | Contact update date. Read only attribute. |
| vat-number | String (Max. length: 15) | Contact Federal Employment Identification Number or Social Security Number. |
| web | String (Max. length: 255) | Contact web address. |
INVOICES
| Attribute | Data type | Description |
|---|---|---|
| account-id | Integer | Your account unique identifier. Read only attribute. |
| contact-id | Integer | Client unique identifier. It cannot be null. |
| created-at | Datetime | Sale creation date. Read only attribute. |
| currency-code | String (Max. length: 3) | Sale ISO currency code. You can obtain ISO codes from countries resource. It cannot be null. |
| due-date | Datetime | Expiration date of the sale. Endeve use this date to calculate late fees. |
| id | Integer | Sale unique identifier. |
| issued-at | Datetime | Sale issue date. |
| items | Array | Sale items. Every sale has at least one item. |
| late-fees-rate | Float (Precision: 2) | Late fees rate applied to the sale after the due date is raised. |
| Notes | String | Notes about the sale. |
| Number | String (Max. length: 20) | Sale number. It has to be unique for your account. It cannot be null. |
| Paid | String (Max. length: 20) | Sale amount paid. |
| payments | Array | Sale payments. |
| Status | Integer | Sale status. 1 => Outstanding. 2 => Paid |
| total | Float (Precision: 2) | Sale total amount after discount and taxes. Read only attribute. |
| updated-at | Datetime | Sale update date. Read only attribute. |
ITEMS
| Attribute | Data type | Description |
|---|---|---|
| description | String (Max. length: 255) | Item description. It cannot be null. |
| discount-rate | Float (Precision: 2) | Discount percentage applied to the item. |
| price | Float (Precision: 3) | Item unit price. It cannot be null. |
| quantity | Float (Precision: 2) | Item quantity. It cannot be null. |
| tax1-name | String (Max. length: 255) | Name of the first tax applied to the item. |
| tax1-rate | Float (precision: 2) | Percentage of the first tax applied to the item. |
| tax2-name | String (Max. length: 255) | Name of the second tax applied to the item. |
| tax2-rate | String (Max. length: 255) | Percentage of the second tax applied to the item. |
| total | Float (precision: 2) | Item total amount after discount and taxes. Read only attribute. |
PAYMENTS
| Attribute | Data type | Description |
|---|---|---|
| amount | Float (precision: 2) | Payment amount. It cannot be null. |
| created-at | Datetime | Sale creation date. Read only attribute. |
| date | Datetime | Payment date. It cannot be null. |
| id | Integer | Payment unique identifier. Read only attribute. |
| payment-method | String (Max. length: 255) | Payment method. It cannot be null. |
| updated-at | Datetime | Sale update date. Read only attribute. |
COUNTRIES
All country attributes are read only.
| Attribute | Data type | Description |
|---|---|---|
| code | String (Max. length: 2) | ISO country code. |
| code3 | String (Max. length: 3) | Extende ISO country code. |
| currency-code | String (Max. length: 3) | ISO country currency code. |
| currency-name | String (Max. length: 255) | Currency name. |
| id | Integer | Country unique identifier. |
| name | String (Max. length: 255) | Country english name. |
| native-name | String (Max. length: 255) | Country native name. |
REGIONS
All region attributes are read only.
| Attribute | Data type | Description |
|---|---|---|
| country-id | Integer | Country identifier where the region is located. |
| id | Integer | Region unique identifier. |
| name | String | Region native name. |
LANGUAGES
All language attributes are read only.
| Attribute | Data type | Description |
|---|---|---|
| code | String (Max. length: 2) | Language ISO code. |
| id | Integer | Language unique identifier. |
| name | String (Max. length: 255) | Language english name. |
| native-name | String (Max. length: 255) | Language native name. |
