111 lines
2.6 KiB
Markdown
111 lines
2.6 KiB
Markdown
---
|
|
name: invoices-routes
|
|
description: Handle 10 OpenAPI operation(s) under /v2/invoices for the invoices route group.
|
|
---
|
|
|
|
# invoices API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /v2/invoices for the invoices route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_invoices
|
|
|
|
- Operation ID: `list_invoices`
|
|
- Route: `GET /v2/invoices`
|
|
- Mode: READ
|
|
- Summary: ListInvoices
|
|
- Parameters:
|
|
- `location_id` in `query` required
|
|
- `cursor` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_invoice
|
|
|
|
- Operation ID: `create_invoice`
|
|
- Route: `POST /v2/invoices`
|
|
- Mode: WRITE
|
|
- Summary: CreateInvoice
|
|
- Body: JSON request body accepted.
|
|
|
|
### search_invoices
|
|
|
|
- Operation ID: `search_invoices`
|
|
- Route: `POST /v2/invoices/search`
|
|
- Mode: WRITE
|
|
- Summary: SearchInvoices
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_invoice
|
|
|
|
- Operation ID: `delete_invoice`
|
|
- Route: `DELETE /v2/invoices/{invoice_id}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteInvoice
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- `version` in `query`
|
|
|
|
### get_invoice
|
|
|
|
- Operation ID: `get_invoice`
|
|
- Route: `GET /v2/invoices/{invoice_id}`
|
|
- Mode: READ
|
|
- Summary: GetInvoice
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
|
|
### update_invoice
|
|
|
|
- Operation ID: `update_invoice`
|
|
- Route: `PUT /v2/invoices/{invoice_id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateInvoice
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_invoice_attachment
|
|
|
|
- Operation ID: `create_invoice_attachment`
|
|
- Route: `POST /v2/invoices/{invoice_id}/attachments`
|
|
- Mode: WRITE
|
|
- Summary: CreateInvoiceAttachment
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_invoice_attachment
|
|
|
|
- Operation ID: `delete_invoice_attachment`
|
|
- Route: `DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteInvoiceAttachment
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- `attachment_id` in `path` required
|
|
|
|
### cancel_invoice
|
|
|
|
- Operation ID: `cancel_invoice`
|
|
- Route: `POST /v2/invoices/{invoice_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: CancelInvoice
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### publish_invoice
|
|
|
|
- Operation ID: `publish_invoice`
|
|
- Route: `POST /v2/invoices/{invoice_id}/publish`
|
|
- Mode: WRITE
|
|
- Summary: PublishInvoice
|
|
- Parameters:
|
|
- `invoice_id` in `path` required
|
|
- Body: JSON request body accepted.
|