43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
---
|
|
name: invoice-payments-routes
|
|
description: Handle 2 OpenAPI operation(s) under /v1/invoice_payments for the invoice payments route group.
|
|
---
|
|
|
|
# invoice payments API Routes
|
|
|
|
Handle 2 OpenAPI operation(s) under /v1/invoice_payments for the invoice payments 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
|
|
|
|
### get_invoice_payments
|
|
|
|
- Operation ID: `get_invoice_payments`
|
|
- Route: `GET /v1/invoice_payments`
|
|
- Mode: READ
|
|
- Summary: List all payments for an invoice
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `invoice` in `query`
|
|
- `limit` in `query`
|
|
- `payment` in `query`
|
|
- `starting_after` in `query`
|
|
- `status` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_invoice_payments_invoice_payment
|
|
|
|
- Operation ID: `get_invoice_payments_invoice_payment`
|
|
- Route: `GET /v1/invoice_payments/{invoice_payment}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an InvoicePayment
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `invoice_payment` in `path` required
|
|
- Body: JSON request body accepted.
|