Skip to content

thirdParty

Represents a customer or supplier (third-party entity). Used by both the Customers and Suppliers endpoints.

Schema

Field Type Required Read-only Description
id integer — ✓ Internal record ID
code string (max 15) — ✓ Auto-assigned entity code
name string (1–40) Yes — Primary name
name_2 string (max 40) — — Secondary name or trading name
vat_id string (max 20) — — VAT / tax identification number
country_iso string — — ISO country code (e.g., PT, ES, GB)
phone string (max 20) — — Phone number
mobile string (max 20) — — Mobile number
fax string (max 20) — — Fax number
email string (email) — — Email address
url_link string (uri) — — Website URL
discount_group string — — Assigned discount group
salesperson string — — Associated salesperson code
electronic_document_interchange string — — EDI flag or identifier
edi_identifier string (max 40) — — EDI identifier
inactive string — — Marks the entity as inactive
comments string — — Free-text comments
billing_address postalAddress — — Billing address
shipping_address postalAddress — — Shipping / delivery address

postalAddress

Embedded address object used in billing_address and shipping_address.

Field Type Required Description
id integer — Internal address ID (read-only)
postal_address string (max 40) — Street address
city string (max 40) — City
zip_code string (max 40) — Postal / ZIP code
country string — Country (ISO code or name)

Example

{
  "id": 1,
  "code": "C0001",
  "name": "Acme Corporation",
  "name_2": "Acme",
  "vat_id": "PT123456789",
  "country_iso": "PT",
  "phone": "+351211234567",
  "mobile": "+351921234567",
  "email": "billing@acme.com",
  "url_link": "https://www.acme.com",
  "salesperson": "JOHN",
  "comments": "Key account",
  "billing_address": {
    "postal_address": "Rua da Liberdade 1",
    "city": "Lisboa",
    "zip_code": "1250-001",
    "country": "PT"
  },
  "shipping_address": {
    "postal_address": "Parque Industrial, Lote 5",
    "city": "Setúbal",
    "zip_code": "2900-001",
    "country": "PT"
  }
}

Used By