Skhokho API

# Vendors

The vendors endpoint url is:

https://skhokho.io/api/v1.0/vendors

# Vendors GET Request

Vendors GET request will fetch a list of vendors associated with the company of the user who is currently authenticated. The structure of the list will be:

[
  {
    "id": 712,
    "companyName": "DCX Corp",
    "companyEmail": "dcxcorp@gmail.com",
    "companyPhone": "099333733",
    "companyTaxNumber": "536563252",
    "addressLine1": "35 Bakers Street",
    "city": "Bloemfontein",
    "state": "Free State",
    "country": "South Africa",
    "postalCode": "4532",
    "uniqueId": "xxxxxxxxxxxx"
    },
    . . . . . // Other Results
]

# Vendors POST Request

When you want to create a new vendors record, you can send a POST request to the vendors end-point.

Vendors Payload Example:

{
  "companyName": "Miyo Enterprises",
  "companyEmail": "miyoenterprises@gmail.com",
  "companyPhone": "099333733",
  "companyTaxNumber": "536563252",
  "addressLine1": "35 Bakers Street",
  "city": "Bloemfontein",
  "state": "Free State",
  "country": "South Africa",
  "postalCode": "4532",
}
Field Required/Optional Json Key Data Type
Company Name Required companyName string
Company Email Required companyEmail string
Company Phone Required companyPhone string
Company Tax Number Optional companyTaxNumber string
Address Line 1 Optional addressLine1 string
City Optional city string
State Optional state string
Country Optional country string
Postal Code Optional postalCode string

← Expenses →