Suppliers

Suppliers

get

Responses

200

OK

application/json

idstringOptional

typestring · enumOptionalPossible values:

namestringOptional

abnstring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

account_numberstring · nullableOptional

websitestring · nullableOptional

payment_termsintegerOptional

payment_terms_periodstringOptional

currencystringOptional

notesstring · nullableOptional

last_modified_atstring · nullableOptional

get

/v1/suppliers/

HTTPcURLJavaScriptPython

GET /v1/suppliers/ HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "email": "text",
    "phone": "text",
    "account_number": "text",
    "website": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "currency": "text",
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]