Skip to content

Update api docs appointment filter #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/agents/agents.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sections:
title: List all Agents
id: list-all-agents
description: /agents/list-all-agents.md
filters: /agents/agent-object.yml
filters: /agents/agent-object-v2.yml
code: /agents/list-all-agents.py
code_type: GET
code_url: /api/agents/
Expand Down
8 changes: 8 additions & 0 deletions pages/appointments/appointment-object.yml
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,14 @@ filters:
name: recipient
type: integer
description: Filter by the Appointment's linked Student (id).
-
name: client
type: integer
description: Filter by the Appointment's linked Client (id).
-
name: status
type: string
description: Filter by the Appointment's status (string).
-
name: location
type: integer
Expand Down
2 changes: 1 addition & 1 deletion pages/clients/clients.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sections:
title: List all Clients
id: list-all-clients
description: /clients/list-all-clients.md
filters: /clients/client-object.yml
filters: /clients/client-object-v2.yml
code: /clients/list-all-clients.py
code_type: GET
code_url: /api/clients/
Expand Down
2 changes: 1 addition & 1 deletion pages/contractors/contractors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sections:
title: List all Contractors
id: list-all-contractors
description: /contractors/list-all-contractors.md
filters: /contractors/contractor-object.yml
filters: /contractors/contractor-object-v2.yml
code: /contractors/list-all-contractors.py
code_type: GET
code_url: /api/contractors/
Expand Down
16 changes: 16 additions & 0 deletions pages/proforma-invoices/proforma-invoice-object.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,19 @@ attributes:
name: still_to_pay
type: decimal
description: Amount of the Proforma Invoice that still needs to be payed.
-
name: description
type: string
description: Description for the Proforma Invoice item (required for creation).
-
name: send_pfi
type: boolean
description: |
(Deprecated - use raise_behaviour instead) Send the PFI as well as creating it. Default is false.
-
name: raise_behaviour
type: string
description: |
Raise behavior when creating a Proforma Invoice. Choices are `dont-raise` (default), `raise`, or `raise-and-send`.
If `dont-raise` is used, the PFI will be created but not sent. If `raise` is used, the PFI will be created and staged.
If `raise-and-send` is used, the PFI will be created, staged, and sent to the client.
2 changes: 1 addition & 1 deletion pages/recipients/recipients.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sections:
title: List all Recipients
id: list-all-recipients
description: /recipients/list-all-recipients.md
filters: /recipients/recipient-object.yml
filters: /recipients/recipient-object-v2.yml
code: /recipients/list-all-recipients.py
code_type: GET
code_url: /api/recipients/
Expand Down