API Reference

Get Estimates Of Client

get
https://api.vcita.biz/platform/v1/clients//estimates

Overview

Gets a list of estimates for a client.

Authentication

Available for Directory tokens only. Requires X-On-Behalf-Of header with the business UID.

Note: Staff OAuth tokens fail with 422 'Unauthorized' even with payments.manage permission due to authorization type mismatch in the backend. Use Directory tokens with X-On-Behalf-Of header instead.

Note on Authorization Header: Both Authorization: Bearer <token> and legacy Authorization: Token <token> formats are supported.

Error Responses

Authorization failures return HTTP 422 with {status:'Error', error:'Unauthorized'} rather than 401/403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

client's id

Query Params
string

Filter by created_at, updated_at, state. state values: issued, approved, draft, invoiced, rejected. available operators for created_at and updated_at: gt, gte, lt, lte, eq. available operators for state: in. example: filter[created_at][gt]=2019-01-01, filter[state][in]=issued,rejected

string

Sort by one of the following: created_at, updated_at, state. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc

Headers
string

A unique identifer of the business. Can be the Business UID or nickname\external ID

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago