API Reference

Get Invoices Of Client

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

Overview

Gets a list of invoices for a client.

Authentication

Available for Staff, App, and Directory Tokens.

Prerequisites

Requires business feature invoicing_features (payments module) to be enabled. Returns 403 Forbidden or 422 Unauthorized if the feature is not enabled.

Error Responses

  • 403 Forbidden: Business does not have invoicing_features enabled
  • 422 Unauthorized: {status:'Error', error:'Unauthorized'} - Legacy error format for feature gate failures
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, draft, declined. 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,draft

string

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

string

Page offset

string

Page size

Response

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