mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-08 20:22:42 +01:00
Working on api docs
This commit is contained in:
David Bomba
parent
dee516164b
commit
1868d571b5
@ -61,14 +61,18 @@ class OpenApiYaml extends Command
|
||||
|
||||
$this->info($file);
|
||||
|
||||
}
|
||||
|
||||
Storage::disk('base')->delete('/openapi/api-docs.yaml');
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/info.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/paths/paths.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/paths/clients.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/components.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas/account.yaml'));
|
||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/misc/misc.yaml'));
|
||||
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
4059
openapi/components/schemas.yaml
Normal file
4059
openapi/components/schemas.yaml
Normal file
File diff suppressed because it is too large
Load Diff
7
openapi/components/schemas/account.yaml
Normal file
7
openapi/components/schemas/account.yaml
Normal file
@ -0,0 +1,7 @@
|
||||
Account:
|
||||
properties:
|
||||
id:
|
||||
description: 'The account hashed id'
|
||||
type: string
|
||||
example: AS3df3A
|
||||
type: object
|
||||
783
openapi/paths/clients.yaml
Normal file
783
openapi/paths/clients.yaml
Normal file
@ -0,0 +1,783 @@
|
||||
/api/v1/clients:
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'List clients'
|
||||
description: |
|
||||
Lists clients. Fine grained filtering is also available using query parameters.
|
||||
operationId: getClients
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
$ref: '#/components/parameters/index'
|
||||
-
|
||||
name: name
|
||||
in: query
|
||||
description: Filter by client name
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: bob
|
||||
-
|
||||
name: balance
|
||||
in: query
|
||||
description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: lt:10
|
||||
-
|
||||
name: between_balance
|
||||
in: query
|
||||
description: Filter between client balances, format uses two values separated by a colon
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 10:100
|
||||
-
|
||||
name: email
|
||||
in: query
|
||||
description: Filter by client email
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: bob@gmail.com
|
||||
-
|
||||
name: id_number
|
||||
in: query
|
||||
description: Filter by client id_number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: number
|
||||
in: query
|
||||
description: Filter by client number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: filter
|
||||
in: query
|
||||
description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: sort
|
||||
in: query
|
||||
description: Returns the list sorted by column in ascending or descending order.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: id|desc name|desc balance|asc
|
||||
|
||||
responses:
|
||||
200:
|
||||
description: 'A list of clients'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Create client'
|
||||
description: 'Adds an client to a company'
|
||||
operationId: storeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the saved client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}':
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Show client'
|
||||
description: 'Displays a client by id'
|
||||
operationId: showClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the cl.ient object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
put:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Update client'
|
||||
description: 'Handles the updating of a client by id'
|
||||
operationId: updateClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
delete:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Delete client'
|
||||
description: 'Handles the deletion of a client by id'
|
||||
operationId: deleteClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns a HTTP status'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/edit':
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Edit Client'
|
||||
description: 'Displays a client by id'
|
||||
operationId: editClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/clients/create:
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Blank Client'
|
||||
description: 'Returns a blank object with default values'
|
||||
operationId: getClientsCreate
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
responses:
|
||||
200:
|
||||
description: 'A blank client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/clients/bulk:
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Bulk actions'
|
||||
description: ''
|
||||
operationId: bulkClients
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/index'
|
||||
requestBody:
|
||||
description: 'User credentials'
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
description: 'Array of hashed IDs to be bulk ''actioned'
|
||||
type: integer
|
||||
example: '[0,1,2,3]'
|
||||
responses:
|
||||
200:
|
||||
description: 'The Client User response'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/upload':
|
||||
put:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Add client document'
|
||||
description: 'Handles the uploading of a document to a client'
|
||||
operationId: uploadClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/purge':
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Purge client'
|
||||
description: 'Handles purging a client'
|
||||
operationId: purgeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge':
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Merge client'
|
||||
description: 'Handles merging 2 clients'
|
||||
operationId: mergeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
-
|
||||
name: mergeable_client_hashed_id
|
||||
in: path
|
||||
description: 'The Mergeable Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/client_statement:
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Client statement PDF'
|
||||
description: 'Return a PDF of the client statement'
|
||||
operationId: clientStatement
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
requestBody:
|
||||
description: 'Statment Options'
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
start_date:
|
||||
description: 'The start date of the statement period - format Y-m-d'
|
||||
type: string
|
||||
end_date:
|
||||
description: 'The start date of the statement period - format Y-m-d'
|
||||
type: string
|
||||
client_id:
|
||||
description: 'The hashed ID of the client'
|
||||
type: string
|
||||
show_payments_table:
|
||||
description: 'Flag which determines if the payments table is shown'
|
||||
type: boolean
|
||||
show_aging_table:
|
||||
description: 'Flag which determines if the aging table is shown'
|
||||
type: boolean
|
||||
type: object
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
401:
|
||||
description: 'Authentication error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthenticationError'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
@ -1541,588 +1541,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/clients:
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'List clients'
|
||||
description: |
|
||||
Lists clients. Fine grained filtering is also available using query parameters.
|
||||
operationId: getClients
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/client_include'
|
||||
-
|
||||
$ref: '#/components/parameters/index'
|
||||
-
|
||||
name: name
|
||||
in: query
|
||||
description: Filter by client name
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: bob
|
||||
-
|
||||
name: balance
|
||||
in: query
|
||||
description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: lt:10
|
||||
-
|
||||
name: between_balance
|
||||
in: query
|
||||
description: Filter between client balances, format uses two values separated by a colon
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: 10:100
|
||||
-
|
||||
name: email
|
||||
in: query
|
||||
description: Filter by client email
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: bob@gmail.com
|
||||
-
|
||||
name: id_number
|
||||
in: query
|
||||
description: Filter by client id_number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: number
|
||||
in: query
|
||||
description: Filter by client number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: filter
|
||||
in: query
|
||||
description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: a1039883
|
||||
-
|
||||
name: sort
|
||||
in: query
|
||||
description: Returns the list sorted by column in ascending or descending order.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: id|desc name|desc balance|asc
|
||||
|
||||
responses:
|
||||
200:
|
||||
description: 'A list of clients'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
403:
|
||||
description: 'Authorization error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#components/schemas/AuthorizationError'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Create client'
|
||||
description: 'Adds an client to a company'
|
||||
operationId: storeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the saved client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}':
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Show client'
|
||||
description: 'Displays a client by id'
|
||||
operationId: showClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the cl.ient object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
put:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Update client'
|
||||
description: 'Handles the updating of a client by id'
|
||||
operationId: updateClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
delete:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Delete client'
|
||||
description: 'Handles the deletion of a client by id'
|
||||
operationId: deleteClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns a HTTP status'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/edit':
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Edit Client'
|
||||
description: 'Displays a client by id'
|
||||
operationId: editClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/clients/create:
|
||||
get:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Blank Client'
|
||||
description: 'Returns a blank object with default values'
|
||||
operationId: getClientsCreate
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
responses:
|
||||
200:
|
||||
description: 'A blank client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/clients/bulk:
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Bulk actions'
|
||||
description: ''
|
||||
operationId: bulkClients
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/index'
|
||||
requestBody:
|
||||
description: 'User credentials'
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
description: 'Array of hashed IDs to be bulk ''actioned'
|
||||
type: integer
|
||||
example: '[0,1,2,3]'
|
||||
responses:
|
||||
200:
|
||||
description: 'The Client User response'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/upload':
|
||||
put:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Add client document'
|
||||
description: 'Handles the uploading of a document to a client'
|
||||
operationId: uploadClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/purge':
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Purge client'
|
||||
description: 'Handles purging a client'
|
||||
operationId: purgeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
'/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge':
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Merge client'
|
||||
description: 'Handles merging 2 clients'
|
||||
operationId: mergeClient
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
-
|
||||
name: id
|
||||
in: path
|
||||
description: 'The Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
-
|
||||
name: mergeable_client_hashed_id
|
||||
in: path
|
||||
description: 'The Mergeable Client Hashed ID'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/client_gateway_tokens:
|
||||
get:
|
||||
tags:
|
||||
@ -2434,69 +1853,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/api/v1/client_statement:
|
||||
post:
|
||||
tags:
|
||||
- clients
|
||||
summary: 'Client statement PDF'
|
||||
description: 'Return a PDF of the client statement'
|
||||
operationId: clientStatement
|
||||
parameters:
|
||||
-
|
||||
$ref: '#/components/parameters/X-API-TOKEN'
|
||||
-
|
||||
$ref: '#/components/parameters/X-Requested-With'
|
||||
-
|
||||
$ref: '#/components/parameters/include'
|
||||
requestBody:
|
||||
description: 'Statment Options'
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
start_date:
|
||||
description: 'The start date of the statement period - format Y-m-d'
|
||||
type: string
|
||||
end_date:
|
||||
description: 'The start date of the statement period - format Y-m-d'
|
||||
type: string
|
||||
client_id:
|
||||
description: 'The hashed ID of the client'
|
||||
type: string
|
||||
show_payments_table:
|
||||
description: 'Flag which determines if the payments table is shown'
|
||||
type: boolean
|
||||
show_aging_table:
|
||||
description: 'Flag which determines if the aging table is shown'
|
||||
type: boolean
|
||||
type: object
|
||||
responses:
|
||||
200:
|
||||
description: 'Returns the client object'
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
|
||||
X-RateLimit-Remaining:
|
||||
$ref: '#/components/headers/X-RateLimit-Remaining'
|
||||
X-RateLimit-Limit:
|
||||
$ref: '#/components/headers/X-RateLimit-Limit'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Client'
|
||||
422:
|
||||
description: 'Validation error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ValidationError'
|
||||
default:
|
||||
description: 'Unexpected Error'
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
|
||||
/api/v1/companies:
|
||||
get:
|
||||
tags:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user