Customers

Customers

get

Responses

200

OK

application/json

idintegerOptional

namestringOptional

get/v1/customers/groups/

GET /v1/customers/groups/ HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": 1,
    "name": "text"
  }
]

get

Responses

200

OK

application/json

idstringOptional

typestring · enumOptionalPossible values:

namestringOptional

abnstring · nullableOptional

account_numberstring · nullableOptional

websitestring · nullableOptional

logo_urlstring · nullableOptional

payment_termsintegerOptional

payment_terms_periodstringOptional

credit_holdbooleanOptional

notesstring · nullableOptional

last_modified_atstring · nullableOptional

get/v1/customers/

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

200

OK

[
  {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "account_number": "text",
    "website": "text",
    "logo_url": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "credit_hold": true,
    "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"
      }
    ]
  }
]

post

Body

namestringRequired

abnstring · nullableOptionalDefault: null

account_numberstring · nullableOptionalDefault: null

websitestring · nullableOptionalDefault: null

logo_urlstring · nullableOptionalDefault: null

payment_termsintegerOptionalDefault: 0

payment_terms_periodstringOptionalDefault: days

notesstring · nullableOptionalDefault: null

locationone of · nullableOptionalDefault: null

contactone of · nullableOptionalDefault: null

groupsinteger[]OptionalDefault: []

Responses

201

Created

application/json

idstringOptional

typestring · enumOptionalPossible values:

namestringOptional

abnstring · nullableOptional

account_numberstring · nullableOptional

websitestring · nullableOptional

logo_urlstring · nullableOptional

payment_termsintegerOptional

payment_terms_periodstringOptional

credit_holdbooleanOptional

notesstring · nullableOptional

last_modified_atstring · nullableOptional

post/v1/customers/

POST /v1/customers/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "name": "text",
  "abn": "text",
  "account_number": "text",
  "website": "text",
  "logo_url": "text",
  "payment_terms": 0,
  "payment_terms_period": "days",
  "notes": "text",
  "location": {
    "address": "text",
    "suburb": "text",
    "state": "text",
    "postcode": "text",
    "country": "AU"
  },
  "contact": {
    "first_name": "text",
    "last_name": "",
    "email": "",
    "phone": "",
    "role": "Primary"
  },
  "groups": [
    1
  ]
}

201

Created

[
  {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "account_number": "text",
    "website": "text",
    "logo_url": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "credit_hold": true,
    "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"
      }
    ]
  }
]