deploy

skills/credit-notes/SKILL.md

@@ -0,0 +1,133 @@
+---
+name: credit-notes-routes
+description: Handle 8 OpenAPI operation(s) under /v1/credit_notes for the credit notes route group.
+---
+
+# credit notes API Routes
+
+Handle 8 OpenAPI operation(s) under /v1/credit_notes for the credit notes 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_credit_notes
+
+- Operation ID: `get_credit_notes`
+- Route: `GET /v1/credit_notes`
+- Mode: READ
+- Summary: List all credit notes
+- Parameters:
+  - `created` in `query`
+  - `customer` in `query`
+  - `customer_account` in `query`
+  - `ending_before` in `query`
+  - `expand` in `query`
+  - `invoice` in `query`
+  - `limit` in `query`
+  - `starting_after` in `query`
+- Body: JSON request body accepted.
+
+### post_credit_notes
+
+- Operation ID: `post_credit_notes`
+- Route: `POST /v1/credit_notes`
+- Mode: WRITE
+- Summary: Create a credit note
+- Body: JSON request body accepted.
+
+### get_credit_notes_preview
+
+- Operation ID: `get_credit_notes_preview`
+- Route: `GET /v1/credit_notes/preview`
+- Mode: READ
+- Summary: Preview a credit note
+- Parameters:
+  - `amount` in `query`
+  - `credit_amount` in `query`
+  - `effective_at` in `query`
+  - `email_type` in `query`
+  - `expand` in `query`
+  - `invoice` in `query` required
+  - `lines` in `query`
+  - `memo` in `query`
+  - `metadata` in `query`
+  - `out_of_band_amount` in `query`
+  - `reason` in `query`
+  - `refund_amount` in `query`
+  - `refunds` in `query`
+  - `shipping_cost` in `query`
+- Body: JSON request body accepted.
+
+### get_credit_notes_preview_lines
+
+- Operation ID: `get_credit_notes_preview_lines`
+- Route: `GET /v1/credit_notes/preview/lines`
+- Mode: READ
+- Summary: Retrieve a credit note preview's line items
+- Parameters:
+  - `amount` in `query`
+  - `credit_amount` in `query`
+  - `effective_at` in `query`
+  - `email_type` in `query`
+  - `ending_before` in `query`
+  - `expand` in `query`
+  - `invoice` in `query` required
+  - `limit` in `query`
+  - `lines` in `query`
+  - `memo` in `query`
+  - `metadata` in `query`
+  - `out_of_band_amount` in `query`
+  - `reason` in `query`
+  - `refund_amount` in `query`
+  - `refunds` in `query`
+  - `shipping_cost` in `query`
+  - `starting_after` in `query`
+- Body: JSON request body accepted.
+
+### get_credit_notes_credit_note_lines
+
+- Operation ID: `get_credit_notes_credit_note_lines`
+- Route: `GET /v1/credit_notes/{credit_note}/lines`
+- Mode: READ
+- Summary: Retrieve a credit note's line items
+- Parameters:
+  - `credit_note` in `path` required
+  - `ending_before` in `query`
+  - `expand` in `query`
+  - `limit` in `query`
+  - `starting_after` in `query`
+- Body: JSON request body accepted.
+
+### get_credit_notes_id
+
+- Operation ID: `get_credit_notes_id`
+- Route: `GET /v1/credit_notes/{id}`
+- Mode: READ
+- Summary: Retrieve a credit note
+- Parameters:
+  - `expand` in `query`
+  - `id` in `path` required
+- Body: JSON request body accepted.
+
+### post_credit_notes_id
+
+- Operation ID: `post_credit_notes_id`
+- Route: `POST /v1/credit_notes/{id}`
+- Mode: WRITE
+- Summary: Update a credit note
+- Parameters:
+  - `id` in `path` required
+- Body: JSON request body accepted.
+
+### post_credit_notes_id_void
+
+- Operation ID: `post_credit_notes_id_void`
+- Route: `POST /v1/credit_notes/{id}/void`
+- Mode: WRITE
+- Summary: Void a credit note
+- Parameters:
+  - `id` in `path` required
+- Body: JSON request body accepted.