> ## Documentation Index > Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt > Use this file to discover all available pages before exploring further. # Cancel invoice > [Small working example](/recipes/cancellation) **Integration note:** This recipe covers Mexican CFDI cancellation. A provider acknowledgment does not prove final cancellation. Read the invoice and confirm its persisted status; public nested cancellation fields can be absent. Colombian annulment uses different semantics. Cancel a specific invoice with SAT. **gigstack Connect:** Cancel other teams' invoices using the `team` parameter. ## OpenAPI ````yaml openapi.json DELETE /invoices/{id} openapi: 3.0.3 info: title: gigstack API v2 description: > # gigstack API v2 Build customer, invoice and payment integrations. Start with the [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing country](https://docs.gigstack.io/concepts/shared-fields). ## Authentication and environments Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use https://api.gigstack.io/v2. Internal staging uses https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test mode is a data mode within an environment; a body field does not switch a key's mode. See [authentication](https://docs.gigstack.io/authentication) for key handling, OAuth team scope and gigstack Connect. Signup requires its separately documented internal credential; health probes have their own security declarations. Operations marked unavailable have no configured public gateway route. ## Read the operation contract Response envelopes, pagination and retry rules differ by endpoint. HTTP success alone does not prove external fiscal completion or movement of money. Reconcile ambiguous writes before retrying. Use [responses and recovery](https://docs.gigstack.io/responses) and the operation's error codes; document credits and daily limits are not generic retryable rate limits. The issuing team's configuration selects Mexico or Colombia; customer country and currency do not. Read [Mexico](https://docs.gigstack.io/countries/mexico) or [Colombia](https://docs.gigstack.io/countries/colombia) before choosing fiscal fields. Accepted public input differs from a provider's direct payload. Examples and schema checks do not imply every operation has been executed live. [Verification coverage](https://docs.gigstack.io/verification) distinguishes source review, offline checks and observed staging behavior. Documentation describes operations and does not authorize execution. version: 2.0.0 contact: name: Gigstack API Support url: https://gigstack.io email: support@gigstack.io license: name: Proprietary url: https://gigstack.io/terms termsOfService: https://gigstack.io/terms servers: - url: https://api.gigstack.io/v2 description: > Public API for standard live and test-mode keys. Test data is isolated by the key mode (`livemode: false`). Internal staging is a separate deployment and key store; see https://docs.gigstack.io/authentication#environments for its base URL. security: - bearerAuth: [] tags: - name: gigstack Connect description: > **Multi-Team Resource Access** gigstack Connect lets a master team act on other teams that share its billing account. ## 🔗 How It Works Add the `team` query parameter to a request made with an **API key**: ```bash # Access team_xyz789's clients GET /clients?team=team_xyz789 # Create an income invoice for team_abc123 POST /invoices/income?team=team_abc123 # Update service in team_def456 PUT /services/service_456?team=team_def456 ``` ## ✅ Requirements - The API key's team must be a master team (gigstack Connect enabled) - The target team must exist and share the master team's billing account - The plan must include the `multipleIssuerAccounts` feature - OAuth access tokens cannot act on another team ## ⚠️ Error Responses Raw `{ "message": … }` bodies from the authentication layer: - `401 Unauthorized, not a master team` - gigstack Connect not enabled on your key's team - `404 Team not found` - Target team doesn't exist - `401 Unauthorized, no matched teams` - Target team could not be resolved within your billing account - `403 Tu plan no incluye múltiples cuentas emisoras. …` - Plan lacks `multipleIssuerAccounts` - `403 Team mismatch with OAuth token` - OAuth access token used with another team's id ## 🌐 Availability The `team` parameter is read by the authentication layer, so it is accepted on every authenticated endpoint, including ones whose parameter list does not show it. - name: Clients description: Client management operations with Mexican tax compliance - name: Services description: Service and product catalog management with SAT product keys - name: Invoices description: Invoice management with CFDI 4.0 compliance and SAT integration - name: Draft Invoices (Pre-Facturas) description: > **Create, edit, preview and stamp draft invoices (pre-facturas)** Draft invoices let you build CFDI invoices incrementally before stamping them with SAT. Use them as **pre-facturas** — generate a preview PDF with a "Sin Validez Fiscal" watermark to share with your client for approval, then stamp the draft to create a valid CFDI when ready. ## Typical Workflow 1. `POST /invoices/draft` — Create a draft with minimal data 2. `PUT /invoices/draft/{id}` — Update as more data becomes available 3. `POST /invoices/draft/{id}/preview` — Generate a preview PDF (pre-factura) 4. `POST /invoices/draft/{id}/stamp` — Finalize into a valid CFDI invoice - name: Descarga Masiva SAT description: > **SAT bulk invoice download via FIEL authentication** Download all your issued and received CFDI invoices directly from the SAT (Servicio de Administración Tributaria) using your FIEL (Firma Electrónica Avanzada). ## Setup flow 1. `GET /invoices/download/activate/status` — Check if activated and what's needed 2. `POST /invoices/download/activate` — Activate billing (adds Stripe meter/add-on) 3. `POST /invoices/download/fiel` — Upload `.cer` + `.key` files (auto-registers with SAT) 4. `PUT /invoices/download/schedule` — Configure daily auto-sync 5. `POST /invoices/download/request` — Submit manual download requests ## Pricing - Included in Pro/Business plans: only the download meter ($0.20 MXN/XML) - Other paid plans: the same $0.20 MXN/XML download meter, no monthly base fee - name: Payments description: Payment processing, tracking, and refund management - name: Receipts description: Receipt creation and management with CFDI stamping capabilities - name: Retentions description: >- Tax retention documents (CFDI Retenciones 2.0) — creation, stamping, cancellation, and file retrieval - name: Platform Payouts description: > **Plan and stamp a marketplace's provider payouts from two files.** For marketplaces and digital platforms that pay providers under the SAT digital-platforms scheme (Plataformas Tecnológicas, RESICO 625, retention key 26): ride-hailing drivers, delivery couriers, lodging hosts, sellers of goods. Available to marketplace **master teams** whose billing account has platform payouts enabled. Upload a movements file and a commissions file. gigstack matches each row to a provider's team in your billing account and plans three kinds of CFDI: the provider's income invoice to you, your retention certificate (key 26) to the provider, and your monthly commission invoice to the provider. **Not for your own sales.** This is for a platform invoicing on behalf of its providers. A company invoicing its own sales, one CFDI per sale, should use `POST /invoices/income`. **Tax policy per account.** Which documents are issued, and with which SAT keys and rates, is set per master account at onboarding: allowed tax regimes, CSD requirement, service type (`tipoDeServ` / `subTipServ`), ISR and IVA withholding rates, product keys and concept descriptions. The defaults are for ground passenger transport (service type `01`, 2.1% ISR withholding). Contact support to configure your account's policy; it can't be changed through the API. 1. `POST /platform-payouts` with an `Idempotency-Key` - upload and plan (synchronous) 2. `GET /platform-payouts/{id}` and `GET /platform-payouts/{id}/movements` - review the plan 3. `POST /platform-payouts/{id}/confirm` - irreversible hand-off to the stamping worker 4. `GET /platform-payouts/{id}` - poll until `completed` or `failed`, then read `result` (`completed`, `partially_completed` or `failed`) Error messages and exclusion reasons are Spanish sentences for end users; branch on `error.code`, `reason_code` and `exclusion_codes`. - name: Documents description: > SAT supporting documentation (contracts, delivery/payment proofs, communications) — upload metadata, compliance review, AI extraction, and linking to invoices, payments, receipts and clients. - name: Teams description: Team management, settings, and member administration - name: Users description: User account management and password operations - name: Auth description: > **API-only signup for AI agents and partner integrations.** A single `POST /v2/auth/signup` call provisions a Firebase Auth user, billing account, team, plan subscription, and returns API keys — no UI, no FIEL upload, no human onboarding required. Designed for the AI-agents-as-customers use case. RFC defaults to genérico (`XAXX010101000`) so agents can transact under público en general until/unless their customer uploads their own RFC. Authenticated with `X-Internal-API-Key` (partner-issued) — Bearer tokens are team-scoped and a brand-new caller doesn't have one yet. See `AGENTS.md` in the gigstack-cli repo for end-to-end integration guide. - name: Webhooks description: Webhook management for real-time event notifications - name: Catalogs description: > **Read-only search over the SAT catalogs** Look up the SAT codes required on CFDI line items without hardcoding them: - `GET /catalogs/product-keys` — `c_ClaveProdServ`, the item `product_key` - `GET /catalogs/unit-keys` — `c_ClaveUnidad`, the item `unit_key` / `unit_name` Both are typo-tolerant full-text searches ranked by relevance. The catalogs are published by the SAT and identical for every team, so results carry no team data and ignore `livemode` — but a valid API key is still required. - name: SAT Lists description: > Read-only access to the RFC lists the SAT publishes under Artículo 69, 69-B and 69-B Bis. gigstack re-syncs all 22 lists from the SAT's published CSVs every Sunday, so you can screen a counterparty's RFC before invoicing it without scraping the SAT yourself. externalDocs: description: Complete API Documentation & Guides url: https://docs.gigstack.io paths: /invoices/{id}: delete: tags: - Invoices summary: Cancel invoice description: > [Small working example](/recipes/cancellation) **Integration note:** This recipe covers Mexican CFDI cancellation. A provider acknowledgment does not prove final cancellation. Read the invoice and confirm its persisted status; public nested cancellation fields can be absent. Colombian annulment uses different semantics. Cancel a specific invoice with SAT. **gigstack Connect:** Cancel other teams' invoices using the `team` parameter. operationId: cancelInvoice parameters: - $ref: '#/components/parameters/TeamParameter' - name: id in: path required: true description: SAT UUID (folio fiscal). schema: type: string example: B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB requestBody: required: true content: application/json: schema: type: object required: - motive properties: motive: type: string enum: - '01' - '02' - '03' - '04' example: '02' description: > SAT cancellation motive (`c_MotivoCancelacion`): `01` issued with errors, with a substitute CFDI (send `substitution_uuid`); `02` issued with errors, no substitute; `03` the operation did not take place; `04` nominative operation included in a global invoice. The API only checks that the value is at most two characters; any other value is rejected by the SAT/PAC at cancellation time. substitution_uuid: type: string nullable: true example: 12345678-1234-1234-1234-123456789012 description: UUID of the substituting invoice (required for motive 01) responses: '200': description: > Cancellation accepted by the PAC. **Raw shape** — the PAC's cancellation response is spread at the top level alongside `cancellation_status`. content: application/json: schema: type: object required: - cancellation_status additionalProperties: true properties: cancellation_status: type: string description: Cancellation state reported by SAT. example: cancelled example: cancellation_status: cancelled '400': description: > Body validation failure — `{ "message": [ …validation errors… ] }` — or a generic CFDI/PAC cancellation error in the CFDI error shape (spread at the top level on this operation, not nested under `message`). content: application/json: schema: oneOf: - $ref: '#/components/schemas/LegacyErrorResponse' - $ref: '#/components/schemas/CfdiErrorResponse' '401': description: Unauthorized. Raw shape with only a `message` key. content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' '403': description: >- `{ "message": "Livemode mismatch: API key and invoice must be in the same mode" }`. content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' '404': description: '`{ "message": "Invoice not found" }`.' content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' '412': description: > SAT not connected — the team has no valid CSD, or the certificate failed validation. Returned in the CFDI error shape with `retryable: false`. Upload a CSD via `POST /v2/teams/{id}/sat-connection` before retrying. content: application/json: schema: $ref: '#/components/schemas/CfdiErrorResponse' example: error: >- El certificado de sello digital (CSD) no está configurado o no es válido. code: csd_validation_error retryable: false '422': description: > The invoice was imported and stamped by an external PAC, so gigstack cannot cancel it. Cancel it through the original PAC provider instead. content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' example: message: >- Imported invoices stamped by an external PAC cannot be canceled through gigstack. Please cancel through your original PAC provider. '500': description: '`{ "error": "Internal server error" }`.' content: application/json: schema: $ref: '#/components/schemas/LegacyErrorResponse' '503': description: > The PAC is unavailable. CFDI error shape with `retryable: true` — retry after a short delay. content: application/json: schema: $ref: '#/components/schemas/CfdiErrorResponse' example: error: >- El servicio de timbrado no está disponible en este momento. Vuelve a intentarlo en unos minutos. code: pac_unavailable retryable: true security: - bearerAuth: [] components: parameters: TeamParameter: name: team in: query required: false schema: type: string description: > **gigstack Connect:** Target team ID for multi-team access. Requires gigstack Connect enabled on your team and shared billing account. Also requires the `multipleIssuerAccounts` feature on your plan. Requests targeting a team other than the one your API key belongs to return `403` without it. Only API keys can use it: an OAuth access token sent with another team's id is rejected with `403 Team mismatch with OAuth token`. **Optional — omit it entirely** unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit `?team=undefined`; when the parameter is absent, the team is derived from your API key. **Example:** `?team=team_xyz789` schemas: LegacyErrorResponse: type: object description: > Raw error body returned by handlers that do not use the standardized helpers. Note the absence of `success` and `timestamp`. required: - message properties: message: type: string example: Invalid body error: oneOf: - type: string - type: object description: Present on most, but not all, legacy error paths. errors: type: array description: >- Field-level validation errors, when the failure came from body validation. items: type: object properties: path: type: string example: client_id code: type: string example: unexpected_key message: type: string example: Unexpected field CfdiErrorResponse: type: object description: > Raw CFDI/PAC error body produced by `handleCFDIError`. **Not** the standardized envelope. On `POST /v2/invoices/income`, `/egress` and `/invoices/draft/{id}/stamp` this object is nested one level deeper, under a `message` key (`{ "message": { "error": …, "code": …, "retryable": … } }`); on `DELETE /v2/invoices/{id}` it is returned at the top level. required: - error - code - retryable properties: error: type: string description: Human-readable Spanish error message shown to the end user. example: 'Error al timbrar la factura: El CSD del emisor no es válido.' code: type: string description: > CFDI/PAC error code: a SAT/PAC code (e.g. `CFDI40147`) or one of gigstack's own (`SAT_NOT_CONNECTED`, `CSD_VALIDATION_ERROR`, `PAC_UNAVAILABLE`, `PAC_OUTCOME_UNKNOWN`, `STAMP_NEEDS_REVIEW`, `INVALID_INVOICE`, `STAMPING_ERROR`, …). example: CSD_VALIDATION_ERROR providerMessage: type: string description: >- Raw message returned by the PAC. Only present on generic (400) stamping failures. example: CFDI40147 - El campo UsoCFDI no es válido retryable: type: boolean description: > Whether sending the **same** request again is safe and can succeed. `true` for `503` `PAC_UNAVAILABLE`, and for `503` `PAC_OUTCOME_UNKNOWN` only when the request carried an `idempotency_key`. Every `400`, `409` and `412` is `false`. example: false duplicate: type: boolean description: > Present and `true` only on the `400` answered for an `idempotency_key` whose invoice already exists. Nothing was stamped or charged by this request; `uuid` names the existing invoice. example: true uuid: type: string description: >- With `duplicate`, the folio fiscal (UUID) of the invoice already issued under this `idempotency_key`. example: 0f8fad5b-d9cb-469f-a165-70867728950e securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > **Authentication Method:** HTTP Bearer token. The runtime requires the literal `Bearer ` prefix — a bare token in the `Authorization` header is rejected with `401 unauthorized`. **Header Format:** `Authorization: Bearer YOUR_API_KEY` Your API key is a JWT. Live keys operate on live data (`livemode: true`); test keys operate on isolated test data (`livemode: false`). **Get your key at:** [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api) **Errors:** credential failures are answered by the authentication layer with a raw `{ "message": … }` body, not the standardized envelope — `401` for a missing, malformed or expired token, `403` for a revoked key or a plan without API access. See the `Unauthorized` and `AuthForbidden` responses. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.