Customers

Your client directory. Customers are referenced by invoices, quotes, expenses, and time entries.

GETList customers

GET/customers
ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page, max 100 (default: 20)
searchstringSearch in name, email, company
sortstringcreatedAt | -createdAt | name | -name
curl "https://paymavo.com/api/v1/customers?search=acme" \
  -H "Authorization: Bearer sk_live_xxx"

GETGet a customer

GET/customers/{id}
curl https://paymavo.com/api/v1/customers/clx123 \
  -H "Authorization: Bearer sk_live_xxx"

POSTCreate a customer

POST/customers
ParameterTypeDescription
name*stringFull name (max 200 chars)
email*emailEmail address
phonestringPhone number
companystringCompany name
streetAddressstringStreet address
postalCodestringPostal code
citystringCity
provincestringProvince / state
countrystringCountry
gstNumberstringGST registration number
qstNumberstringQST registration number
taxExemptbooleanTax exempt (default: false)
curl -X POST https://paymavo.com/api/v1/customers \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Sophie Tremblay", "email": "sophie@example.com", "company": "Studio ST" }'

PATCHUpdate a customer

PATCH/customers/{id}
curl -X PATCH https://paymavo.com/api/v1/customers/clx123 \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "+1-514-555-0100", "city": "Montréal" }'

DELETEDelete a customer

DELETE/customers/{id}
curl -X DELETE https://paymavo.com/api/v1/customers/clx123 \
  -H "Authorization: Bearer sk_live_xxx"