161 lines
4.2 KiB
Markdown
161 lines
4.2 KiB
Markdown
---
|
|
name: tax-routes
|
|
description: Handle 14 OpenAPI operation(s) under /v1/tax for the tax route group.
|
|
---
|
|
|
|
# tax API Routes
|
|
|
|
Handle 14 OpenAPI operation(s) under /v1/tax for the tax 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_tax_associations_find
|
|
|
|
- Operation ID: `get_tax_associations_find`
|
|
- Route: `GET /v1/tax/associations/find`
|
|
- Mode: READ
|
|
- Summary: Find a Tax Association
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `payment_intent` in `query` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_calculations
|
|
|
|
- Operation ID: `post_tax_calculations`
|
|
- Route: `POST /v1/tax/calculations`
|
|
- Mode: WRITE
|
|
- Summary: Create a Calculation
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_calculations_calculation
|
|
|
|
- Operation ID: `get_tax_calculations_calculation`
|
|
- Route: `GET /v1/tax/calculations/{calculation}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Calculation
|
|
- Parameters:
|
|
- `calculation` in `path` required
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_calculations_calculation_line_items
|
|
|
|
- Operation ID: `get_tax_calculations_calculation_line_items`
|
|
- Route: `GET /v1/tax/calculations/{calculation}/line_items`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Calculation's line items
|
|
- Parameters:
|
|
- `calculation` in `path` required
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_registrations
|
|
|
|
- Operation ID: `get_tax_registrations`
|
|
- Route: `GET /v1/tax/registrations`
|
|
- Mode: READ
|
|
- Summary: List registrations
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- `status` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_registrations
|
|
|
|
- Operation ID: `post_tax_registrations`
|
|
- Route: `POST /v1/tax/registrations`
|
|
- Mode: WRITE
|
|
- Summary: Create a registration
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_registrations_id
|
|
|
|
- Operation ID: `get_tax_registrations_id`
|
|
- Route: `GET /v1/tax/registrations/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a registration
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_registrations_id
|
|
|
|
- Operation ID: `post_tax_registrations_id`
|
|
- Route: `POST /v1/tax/registrations/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update a registration
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_settings
|
|
|
|
- Operation ID: `get_tax_settings`
|
|
- Route: `GET /v1/tax/settings`
|
|
- Mode: READ
|
|
- Summary: Retrieve settings
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_settings
|
|
|
|
- Operation ID: `post_tax_settings`
|
|
- Route: `POST /v1/tax/settings`
|
|
- Mode: WRITE
|
|
- Summary: Update settings
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_transactions_create_from_calculation
|
|
|
|
- Operation ID: `post_tax_transactions_create_from_calculation`
|
|
- Route: `POST /v1/tax/transactions/create_from_calculation`
|
|
- Mode: WRITE
|
|
- Summary: Create a Transaction from a Calculation
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_tax_transactions_create_reversal
|
|
|
|
- Operation ID: `post_tax_transactions_create_reversal`
|
|
- Route: `POST /v1/tax/transactions/create_reversal`
|
|
- Mode: WRITE
|
|
- Summary: Create a reversal Transaction
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_transactions_transaction
|
|
|
|
- Operation ID: `get_tax_transactions_transaction`
|
|
- Route: `GET /v1/tax/transactions/{transaction}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Transaction
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `transaction` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_tax_transactions_transaction_line_items
|
|
|
|
- Operation ID: `get_tax_transactions_transaction_line_items`
|
|
- Route: `GET /v1/tax/transactions/{transaction}/line_items`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Transaction's line items
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- `transaction` in `path` required
|
|
- Body: JSON request body accepted.
|