Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo)
Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes)
Folio auto-generation
SAT stamping, PDF and XML generation
gigstack Connect: Create retentions for other teams using the team parameter.
Conditional requirements per retention_key
retention_key is validated as a free-form string — any SAT key is accepted — but three
keys carry extra requirements enforced before the document is stamped. A violation
returns 400 with error.code: invalid_request_body and the message quoted below.
retention_key
additional requirement
error message on violation
16 — Intereses
interest object is required
interest object is required for retention key 16 (Intereses)
25 — Otro tipo de retenciones
retention_description is required and non-empty
retention_description is required for retention key 25 (Otro tipo de retenciones)
26 — Plataformas Tecnológicas
platform_services object is required andtaxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS)
platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas
Every other key requires only the base fields (retention_key, client,
period_start, period_end, period_year, total_operation, taxes).
Within interest, financial_system, nominal_interest and real_interest are
required. Within platform_services, periodicity and services are required, and
each entry in services requires payment_form, service_type, service_date and
price_without_tax.
Unlike the other modules, this endpoint strips unknown keys instead of rejecting
them (stripUnknown: true), so an undeclared field is silently discarded rather than
returning 400.
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.
Query Parameters
team
string
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
Body
application/json
retention_key
string
required
SAT retention type code (01-26). E.g. "26" for Plataformas Tecnológicas
Example:
"26"
client
object
required
Client reference. Same format as invoices/payments. Three modes:
By ID:{ id: "client_123" } — looks up existing client
By search:{ search: { on_key: "tax_id", on_value: "XAXX010101000", auto_create: true } } — finds or creates
Total operation amount. Taxable amount is auto-calculated as total_operation - total_exempt
Example:
93116.98
taxes
object[]
required
Retained taxes. Use friendly names (ISR, IVA, IEPS) — SAT codes are mapped automatically
Show child attributes
total_exempt
number | null
Total exempt amount (defaults to 0)
Example:
0
series
string | null
Series for folio management (defaults to "RET")
metadata
object | null
Custom metadata
idempotency_key
string | null
Optional stored reference. This handler does not claim or replay this key to prevent duplicate issuance. Reconcile an ambiguous result before another request; do not assume retry safety.
retention_description
string | null
Required only for key "25" (Otro tipo de retenciones). Free-text description of the retention type.
interest
object | null
Required only for key "16" (Intereses). Financial interest complement data.
Show child attributes
platform_services
object | null
Required only for key "26" (Plataformas Tecnológicas). Service details for technology platform retentions. Header totals (IVA trasladado, ISR retenido, etc.) are auto-calculated.
Show child attributes
Response
Retention created and stamped successfully
Standardized success envelope emitted by sendSuccessResponse.
success
enum<boolean>
required
Available options:
true
Example:
true
data
object
required
The operation payload.
timestamp
integer<int64>
required
Server time in epoch milliseconds (Luxon.now().toMillis()).
Example:
1767225600000
message
string
Human-readable summary. Present only when the handler supplies one.
Example:
"Operation completed successfully"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"gigstack","description":"Build invoicing and payment integrations with the gigstack API.","colors":{"primary":"#527A16","light":"#B4E44B","dark":"#527A16"},"logo":{"light":"https://mintcdn.com/gigstack-736714cc/n52DA3e1uZaES4AD/logo/light.svg?fit=max\u0026auto=format\u0026n=n52DA3e1uZaES4AD\u0026q=85\u0026s=c2a76374f23410e1b668aa0f9c87e282","dark":"https://mintcdn.com/gigstack-736714cc/n52DA3e1uZaES4AD/logo/dark.svg?fit=max\u0026auto=format\u0026n=n52DA3e1uZaES4AD\u0026q=85\u0026s=4943719d5ca8657f1121e499d7c7e64b"},"favicon":"https://mintcdn.com/gigstack-736714cc/n52DA3e1uZaES4AD/logo/favicon.svg?fit=max\u0026auto=format\u0026n=n52DA3e1uZaES4AD\u0026q=85\u0026s=06d40fd65140bc9023b235ed1b456268","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python"]}},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"links":[{"href":"mailto:support@gigstack.io","label":"Support"}],"primary":{"type":"button","label":"Open gigstack","href":"https://app.gigstack.pro"}},"fonts":{"family":"Geist"},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gigstack-736714cc","hasAudioNarration":false,"actualSubdomain":"gigstack-736714cc","customDomains":["docs.gigstack.io"],"gitSource":{"type":"github","owner":"disruptive-learning","repo":"backend","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afba6b30b1f44aebe132fb1","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":351},{"language":"default","tag":"Core resources","count":95},{"language":"default","tag":"Teams and access","count":88},{"language":"default","tag":"Account settings and integrations","count":76},{"language":"default","tag":"Guides","count":57},{"language":"default","tag":"Automation and data","count":55},{"language":"default","tag":"Teams","count":43},{"language":"default","tag":"Integrations","count":36},{"language":"default","tag":"SAT and fiscal tools","count":35},{"language":"default","tag":"Invoices","count":33}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"reference/createRetentions","slug":"/reference/createRetentions","pageMetadata":{"openapi":"openapi.json POST /retentions","title":"Create retention","description":"Create and stamp a new tax retention document (CFDI Retenciones 2.0).\n\nThe API accepts a **simplified format** — the backend handles:\n- **Client lookup** by ID (fetches RFC, legal name, address automatically)\n- **Nationality detection** from client's country\n- **Tax code mapping** (`ISR` → 001, `IVA` → 002, `IEPS` → 003)\n- **Payment type defaults** per tax (ISR → provisional, IVA/IEPS → definitivo)\n- **Totals auto-calculation** (taxable = operation − exempt, retained = sum of taxes)\n- **Folio auto-generation**\n- SAT stamping, PDF and XML generation\n\n**gigstack Connect:** Create retentions for other teams using the `team` parameter.\n\n## Conditional requirements per `retention_key`\n\n`retention_key` is validated as a free-form string — any SAT key is accepted — but three\nkeys carry extra requirements enforced before the document is stamped. A violation\nreturns `400` with `error.code: invalid_request_body` and the message quoted below.\n\n| `retention_key` | additional requirement | error message on violation |\n|---|---|---|\n| `16` — Intereses | `interest` object is required | `interest object is required for retention key 16 (Intereses)` |\n| `25` — Otro tipo de retenciones | `retention_description` is required and non-empty | `retention_description is required for retention key 25 (Otro tipo de retenciones)` |\n| `26` — Plataformas Tecnológicas | `platform_services` object is required **and** `taxes` must contain at least one entry whose `tax` is not `IVA` (i.e. `ISR` or `IEPS`) | `platform_services object is required for retention key 26 (Plataformas Tecnológicas)` / `At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas` |\n\nEvery other key requires only the base fields (`retention_key`, `client`,\n`period_start`, `period_end`, `period_year`, `total_operation`, `taxes`).\n\nWithin `interest`, `financial_system`, `nominal_interest` and `real_interest` are\nrequired. Within `platform_services`, `periodicity` and `services` are required, and\neach entry in `services` requires `payment_form`, `service_type`, `service_date` and\n`price_without_tax`.\n\n> Unlike the other modules, this endpoint **strips** unknown keys instead of rejecting\n> them (`stripUnknown: true`), so an undeclared field is silently discarded rather than\n> returning `400`.\n","href":"/reference/createRetentions"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n blockquote: \"blockquote\",\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create and stamp a new tax retention document (CFDI Retenciones 2.0).\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The API accepts a \", _jsx(_components.strong, {\n children: \"simplified format\"\n }), \" — the backend handles:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Client lookup\"\n }), \" by ID (fetches RFC, legal name, address automatically)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Nationality detection\"\n }), \" from client’s country\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Tax code mapping\"\n }), \" (\", _jsx(_components.code, {\n children: \"ISR\"\n }), \" → 001, \", _jsx(_components.code, {\n children: \"IVA\"\n }), \" → 002, \", _jsx(_components.code, {\n children: \"IEPS\"\n }), \" → 003)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Payment type defaults\"\n }), \" per tax (ISR → provisional, IVA/IEPS → definitivo)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Totals auto-calculation\"\n }), \" (taxable = operation − exempt, retained = sum of taxes)\"]\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.strong, {\n children: \"Folio auto-generation\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: \"SAT stamping, PDF and XML generation\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"gigstack Connect:\"\n }), \" Create retentions for other teams using the \", _jsx(_components.code, {\n children: \"team\"\n }), \" parameter.\"]\n }), \"\\n\", _jsxs(_components.h2, {\n children: [\"Conditional requirements per \", _jsx(_components.code, {\n children: \"retention_key\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"retention_key\"\n }), \" is validated as a free-form string — any SAT key is accepted — but three\\nkeys carry extra requirements enforced before the document is stamped. A violation\\nreturns \", _jsx(_components.code, {\n children: \"400\"\n }), \" with \", _jsx(_components.code, {\n children: \"error.code: invalid_request_body\"\n }), \" and the message quoted below.\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: _jsx(_components.code, {\n children: \"retention_key\"\n })\n }), _jsx(_components.th, {\n children: \"additional requirement\"\n }), _jsx(_components.th, {\n children: \"error message on violation\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"16\"\n }), \" — Intereses\"]\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"interest\"\n }), \" object is required\"]\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"interest object is required for retention key 16 (Intereses)\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"25\"\n }), \" — Otro tipo de retenciones\"]\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"retention_description\"\n }), \" is required and non-empty\"]\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"retention_description is required for retention key 25 (Otro tipo de retenciones)\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"26\"\n }), \" — Plataformas Tecnológicas\"]\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"platform_services\"\n }), \" object is required \", _jsx(_components.strong, {\n children: \"and\"\n }), \" \", _jsx(_components.code, {\n children: \"taxes\"\n }), \" must contain at least one entry whose \", _jsx(_components.code, {\n children: \"tax\"\n }), \" is not \", _jsx(_components.code, {\n children: \"IVA\"\n }), \" (i.e. \", _jsx(_components.code, {\n children: \"ISR\"\n }), \" or \", _jsx(_components.code, {\n children: \"IEPS\"\n }), \")\"]\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"platform_services object is required for retention key 26 (Plataformas Tecnológicas)\"\n }), \" / \", _jsx(_components.code, {\n children: \"At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas\"\n })]\n })]\n })]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Every other key requires only the base fields (\", _jsx(_components.code, {\n children: \"retention_key\"\n }), \", \", _jsx(_components.code, {\n children: \"client\"\n }), \",\\n\", _jsx(_components.code, {\n children: \"period_start\"\n }), \", \", _jsx(_components.code, {\n children: \"period_end\"\n }), \", \", _jsx(_components.code, {\n children: \"period_year\"\n }), \", \", _jsx(_components.code, {\n children: \"total_operation\"\n }), \", \", _jsx(_components.code, {\n children: \"taxes\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Within \", _jsx(_components.code, {\n children: \"interest\"\n }), \", \", _jsx(_components.code, {\n children: \"financial_system\"\n }), \", \", _jsx(_components.code, {\n children: \"nominal_interest\"\n }), \" and \", _jsx(_components.code, {\n children: \"real_interest\"\n }), \" are\\nrequired. Within \", _jsx(_components.code, {\n children: \"platform_services\"\n }), \", \", _jsx(_components.code, {\n children: \"periodicity\"\n }), \" and \", _jsx(_components.code, {\n children: \"services\"\n }), \" are required, and\\neach entry in \", _jsx(_components.code, {\n children: \"services\"\n }), \" requires \", _jsx(_components.code, {\n children: \"payment_form\"\n }), \", \", _jsx(_components.code, {\n children: \"service_type\"\n }), \", \", _jsx(_components.code, {\n children: \"service_date\"\n }), \" and\\n\", _jsx(_components.code, {\n children: \"price_without_tax\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"Unlike the other modules, this endpoint \", _jsx(_components.strong, {\n children: \"strips\"\n }), \" unknown keys instead of rejecting\\nthem (\", _jsx(_components.code, {\n children: \"stripUnknown: true\"\n }), \"), so an undeclared field is silently discarded rather than\\nreturning \", _jsx(_components.code, {\n children: \"400\"\n }), \".\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi.json POST /retentions","title":"Create retention","description":"Create and stamp a new tax retention document (CFDI Retenciones 2.0).\n\nThe API accepts a **simplified format** — the backend handles:\n- **Client lookup** by ID (fetches RFC, legal name, address automatically)\n- **Nationality detection** from client's country\n- **Tax code mapping** (`ISR` → 001, `IVA` → 002, `IEPS` → 003)\n- **Payment type defaults** per tax (ISR → provisional, IVA/IEPS → definitivo)\n- **Totals auto-calculation** (taxable = operation − exempt, retained = sum of taxes)\n- **Folio auto-generation**\n- SAT stamping, PDF and XML generation\n\n**gigstack Connect:** Create retentions for other teams using the `team` parameter.\n\n## Conditional requirements per `retention_key`\n\n`retention_key` is validated as a free-form string — any SAT key is accepted — but three\nkeys carry extra requirements enforced before the document is stamped. A violation\nreturns `400` with `error.code: invalid_request_body` and the message quoted below.\n\n| `retention_key` | additional requirement | error message on violation |\n|---|---|---|\n| `16` — Intereses | `interest` object is required | `interest object is required for retention key 16 (Intereses)` |\n| `25` — Otro tipo de retenciones | `retention_description` is required and non-empty | `retention_description is required for retention key 25 (Otro tipo de retenciones)` |\n| `26` — Plataformas Tecnológicas | `platform_services` object is required **and** `taxes` must contain at least one entry whose `tax` is not `IVA` (i.e. `ISR` or `IEPS`) | `platform_services object is required for retention key 26 (Plataformas Tecnológicas)` / `At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas` |\n\nEvery other key requires only the base fields (`retention_key`, `client`,\n`period_start`, `period_end`, `period_year`, `total_operation`, `taxes`).\n\nWithin `interest`, `financial_system`, `nominal_interest` and `real_interest` are\nrequired. Within `platform_services`, `periodicity` and `services` are required, and\neach entry in `services` requires `payment_form`, `service_type`, `service_date` and\n`price_without_tax`.\n\n> Unlike the other modules, this endpoint **strips** unknown keys instead of rejecting\n> them (`stripUnknown: true`), so an undeclared field is silently discarded rather than\n> returning `400`.\n","href":"/reference/createRetentions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createRetentions","tags":["Retentions"],"summary":"Create retention","description":"Create and stamp a new tax retention document (CFDI Retenciones 2.0).\n\nThe API accepts a **simplified format** — the backend handles:\n- **Client lookup** by ID (fetches RFC, legal name, address automatically)\n- **Nationality detection** from client's country\n- **Tax code mapping** (`ISR` → 001, `IVA` → 002, `IEPS` → 003)\n- **Payment type defaults** per tax (ISR → provisional, IVA/IEPS → definitivo)\n- **Totals auto-calculation** (taxable = operation − exempt, retained = sum of taxes)\n- **Folio auto-generation**\n- SAT stamping, PDF and XML generation\n\n**gigstack Connect:** Create retentions for other teams using the `team` parameter.\n\n## Conditional requirements per `retention_key`\n\n`retention_key` is validated as a free-form string — any SAT key is accepted — but three\nkeys carry extra requirements enforced before the document is stamped. A violation\nreturns `400` with `error.code: invalid_request_body` and the message quoted below.\n\n| `retention_key` | additional requirement | error message on violation |\n|---|---|---|\n| `16` — Intereses | `interest` object is required | `interest object is required for retention key 16 (Intereses)` |\n| `25` — Otro tipo de retenciones | `retention_description` is required and non-empty | `retention_description is required for retention key 25 (Otro tipo de retenciones)` |\n| `26` — Plataformas Tecnológicas | `platform_services` object is required **and** `taxes` must contain at least one entry whose `tax` is not `IVA` (i.e. `ISR` or `IEPS`) | `platform_services object is required for retention key 26 (Plataformas Tecnológicas)` / `At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas` |\n\nEvery other key requires only the base fields (`retention_key`, `client`,\n`period_start`, `period_end`, `period_year`, `total_operation`, `taxes`).\n\nWithin `interest`, `financial_system`, `nominal_interest` and `real_interest` are\nrequired. Within `platform_services`, `periodicity` and `services` are required, and\neach entry in `services` requires `payment_form`, `service_type`, `service_date` and\n`price_without_tax`.\n\n> Unlike the other modules, this endpoint **strips** unknown keys instead of rejecting\n> them (`stripUnknown: true`), so an undeclared field is silently discarded rather than\n> returning `400`.\n","security":["4be1f963-09bb-4e33-a71b-1174e05da64e"],"parameters":["cee97606-c09a-4f03-83e1-865cb9d542c1"],"requestBody":"7854552c-972a-4aea-88a5-a4aca70145e1","responses":{"201":"516570c1-f52c-437f-a312-a578791bad8e","400":"7cb87ba3-e76b-498e-807a-8cfe0e92b722","401":"6cd1b613-8ae1-4957-ab30-4d977b9107d3","403":"417bb6ae-2356-4c43-8515-6b3bd9ae74c9"},"method":"post","type":"path","servers":["aab38087-9d60-4eb4-b6c9-2a7ae8d53a00"],"path":"/retentions","baseUrlOptions":["https://api.gigstack.io/v2"],"title":"Create retention","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cee97606-c09a-4f03-83e1-865cb9d542c1":{"name":"team","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"**gigstack Connect:** Target team ID for multi-team access.\n\nRequires gigstack Connect enabled on your team and shared billing account.\n\nAlso requires the `multipleIssuerAccounts` feature on your plan. Requests targeting a\nteam other than the one your API key belongs to return `403` without it.\n\nOnly API keys can use it: an OAuth access token sent with another team's id is rejected with\n`403 Team mismatch with OAuth token`.\n\n**Optional — omit it entirely** unless you are acting on another team. It deliberately\ncarries no example value so generated snippets do not emit `?team=undefined`; when the\nparameter is absent, the team is derived from your API key.\n\n**Example:** `?team=team_xyz789`\n","uniqueKey":"","typeLabel":"string"},"description":"**gigstack Connect:** Target team ID for multi-team access.\n\nRequires gigstack Connect enabled on your team and shared billing account.\n\nAlso requires the `multipleIssuerAccounts` feature on your plan. Requests targeting a\nteam other than the one your API key belongs to return `403` without it.\n\nOnly API keys can use it: an OAuth access token sent with another team's id is rejected with\n`403 Team mismatch with OAuth token`.\n\n**Optional — omit it entirely** unless you are acting on another team. It deliberately\ncarries no example value so generated snippets do not emit `?team=undefined`; when the\nparameter is absent, the team is derived from your API key.\n\n**Example:** `?team=team_xyz789`\n"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["retention_key","client","period_start","period_end","period_year","total_operation","taxes"],"properties":{"retention_key":{"type":"string","description":"SAT retention type code (01-26). E.g. \"26\" for Plataformas Tecnológicas","example":"26","isRequired":true,"uniqueKey":"retention_key","typeLabel":"string"},"client":{"type":"object","description":"Client reference. Same format as invoices/payments. Three modes:\n- **By ID:** `{ id: \"client_123\" }` — looks up existing client\n- **By search:** `{ search: { on_key: \"tax_id\", on_value: \"XAXX010101000\", auto_create: true } }` — finds or creates\n- **Inline:** `{ tax_id: \"XAXX010101000\", legal_name: \"EMPRESA SA\", address: { zip: \"06700\" } }` — creates on-the-fly\n","properties":{"id":{"type":"string","description":"Existing client ID","uniqueKey":"client.id","typeLabel":"string"},"search":{"type":"object","description":"Search for client by field value","properties":{"on_key":{"type":"string","description":"Field to search on (e.g. \"tax_id\", \"email\", \"rfc\")","uniqueKey":"client.search.on_key","typeLabel":"string"},"on_value":{"type":"string","description":"Value to match","uniqueKey":"client.search.on_value","typeLabel":"string"},"auto_create":{"type":"boolean","description":"Create client if not found (default false)","uniqueKey":"client.search.auto_create","typeLabel":"boolean"},"safety_check":{"type":"boolean","description":"Fail if multiple clients match (default false)","uniqueKey":"client.search.safety_check","typeLabel":"boolean"}},"uniqueKey":"client.search","typeLabel":"object"},"tax_id":{"type":"string","description":"RFC / Tax ID (for inline creation)","uniqueKey":"client.tax_id","typeLabel":"string"},"legal_name":{"type":"string","description":"Legal name (for inline creation)","uniqueKey":"client.legal_name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"client.email","typeLabel":"string"},"name":{"type":"string","uniqueKey":"client.name","typeLabel":"string"},"address":{"type":"object","properties":{"zip":{"type":"string","uniqueKey":"client.address.zip","typeLabel":"string"},"country":{"type":"string","uniqueKey":"client.address.country","typeLabel":"string"},"street":{"type":"string","uniqueKey":"client.address.street","typeLabel":"string"},"state":{"type":"string","uniqueKey":"client.address.state","typeLabel":"string"}},"uniqueKey":"client.address","typeLabel":"object"},"tax_system":{"type":"string","description":"Tax system code (e.g. \"601\")","uniqueKey":"client.tax_system","typeLabel":"string"}},"isRequired":true,"uniqueKey":"client","typeLabel":"object"},"period_start":{"type":"number","description":"Start month (1-12)","example":1,"isRequired":true,"uniqueKey":"period_start","typeLabel":"number"},"period_end":{"type":"number","description":"End month (1-12)","example":3,"isRequired":true,"uniqueKey":"period_end","typeLabel":"number"},"period_year":{"type":"number","description":"Fiscal year","example":2026,"isRequired":true,"uniqueKey":"period_year","typeLabel":"number"},"total_operation":{"type":"number","description":"Total operation amount. Taxable amount is auto-calculated as `total_operation - total_exempt`","example":93116.98,"isRequired":true,"uniqueKey":"total_operation","typeLabel":"number"},"taxes":{"type":"array","description":"Retained taxes. Use friendly names (ISR, IVA, IEPS) — SAT codes are mapped automatically","items":{"type":"object","required":["tax","base","amount"],"properties":{"tax":{"type":"string","description":"Tax name: ISR, IVA, or IEPS (mapped to SAT codes 001, 002, 003)","example":"ISR","isRequired":true,"uniqueKey":"taxes.items.[INDEX].tax","typeLabel":"string"},"base":{"type":"number","description":"Tax base amount","example":93116.98,"isRequired":true,"uniqueKey":"taxes.items.[INDEX].base","typeLabel":"number"},"amount":{"type":"number","description":"Retained amount","example":2327.92,"isRequired":true,"uniqueKey":"taxes.items.[INDEX].amount","typeLabel":"number"},"payment_type":{"oneOf":[{"type":"string","description":"Override payment type (01=Definitivo, 03=Provisional). Defaults: ISR→03, IVA→01, IEPS→01","uniqueKey":"taxes.items.[INDEX].payment_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Override payment type (01=Definitivo, 03=Provisional). Defaults: ISR→03, IVA→01, IEPS→01","uniqueKey":"taxes.items.[INDEX].payment_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxes.items.[INDEX].payment_type","typeLabel":"string | null"}},"uniqueKey":"taxes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"taxes","typeLabel":"object[]"},"total_exempt":{"oneOf":[{"type":"number","description":"Total exempt amount (defaults to 0)","example":0,"uniqueKey":"total_exempt.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total exempt amount (defaults to 0)","example":0,"uniqueKey":"total_exempt.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_exempt","typeLabel":"number | null"},"series":{"oneOf":[{"type":"string","description":"Series for folio management (defaults to \"RET\")","uniqueKey":"series.oneOf.0","typeLabel":"string"},{"type":"null","description":"Series for folio management (defaults to \"RET\")","uniqueKey":"series.oneOf.1","typeLabel":"null"}],"uniqueKey":"series","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Custom metadata","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom metadata","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"idempotency_key":{"oneOf":[{"type":"string","description":"Optional stored reference. This handler does not claim or replay this key to prevent duplicate issuance. Reconcile an ambiguous result before another request; do not assume retry safety.","uniqueKey":"idempotency_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional stored reference. This handler does not claim or replay this key to prevent duplicate issuance. Reconcile an ambiguous result before another request; do not assume retry safety.","uniqueKey":"idempotency_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"idempotency_key","typeLabel":"string | null"},"retention_description":{"oneOf":[{"type":"string","description":"Required only for key \"25\" (Otro tipo de retenciones). Free-text description of the retention type.","uniqueKey":"retention_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required only for key \"25\" (Otro tipo de retenciones). Free-text description of the retention type.","uniqueKey":"retention_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"retention_description","typeLabel":"string | null"},"interest":{"oneOf":[{"type":"object","description":"Required only for key \"16\" (Intereses). Financial interest complement data.","properties":{"financial_system":{"type":"string","description":"Financial system flag (SI/NO)","enum":["SI","NO"],"uniqueKey":"interest.oneOf.0.financial_system","typeLabel":"enum\u003cstring>"},"withdrawal_aores":{"oneOf":[{"type":"string","description":"Retiro AORES flag (SI/NO)","enum":["SI","NO",null],"uniqueKey":"interest.oneOf.0.withdrawal_aores.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Retiro AORES flag (SI/NO)","enum":["SI","NO",null],"uniqueKey":"interest.oneOf.0.withdrawal_aores.oneOf.1","typeLabel":"null"}],"uniqueKey":"interest.oneOf.0.withdrawal_aores","typeLabel":"enum\u003cstring> | null"},"financial_derivatives":{"oneOf":[{"type":"string","description":"Financial derivatives flag (SI/NO)","enum":["SI","NO",null],"uniqueKey":"interest.oneOf.0.financial_derivatives.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Financial derivatives flag (SI/NO)","enum":["SI","NO",null],"uniqueKey":"interest.oneOf.0.financial_derivatives.oneOf.1","typeLabel":"null"}],"uniqueKey":"interest.oneOf.0.financial_derivatives","typeLabel":"enum\u003cstring> | null"},"nominal_interest":{"type":"number","description":"Nominal interest amount (3 decimal places)","uniqueKey":"interest.oneOf.0.nominal_interest","typeLabel":"number"},"real_interest":{"type":"number","description":"Real interest amount (3 decimal places)","uniqueKey":"interest.oneOf.0.real_interest","typeLabel":"number"},"loss":{"oneOf":[{"type":"number","description":"Loss amount (3 decimal places)","uniqueKey":"interest.oneOf.0.loss.oneOf.0","typeLabel":"number"},{"type":"null","description":"Loss amount (3 decimal places)","uniqueKey":"interest.oneOf.0.loss.oneOf.1","typeLabel":"null"}],"uniqueKey":"interest.oneOf.0.loss","typeLabel":"number | null"}},"uniqueKey":"interest.oneOf.0","typeLabel":"object"},{"type":"null","description":"Required only for key \"16\" (Intereses). Financial interest complement data.","properties":{"financial_system":{"type":"string","description":"Financial system flag (SI/NO)","enum":["SI","NO"]},"withdrawal_aores":{"oneOf":[{"type":"string","description":"Retiro AORES flag (SI/NO)","enum":["SI","NO",null]},{"type":"null","description":"Retiro AORES flag (SI/NO)","enum":["SI","NO",null]}]},"financial_derivatives":{"oneOf":[{"type":"string","description":"Financial derivatives flag (SI/NO)","enum":["SI","NO",null]},{"type":"null","description":"Financial derivatives flag (SI/NO)","enum":["SI","NO",null]}]},"nominal_interest":{"type":"number","description":"Nominal interest amount (3 decimal places)"},"real_interest":{"type":"number","description":"Real interest amount (3 decimal places)"},"loss":{"oneOf":[{"type":"number","description":"Loss amount (3 decimal places)"},{"type":"null","description":"Loss amount (3 decimal places)"}]}},"uniqueKey":"interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"interest","typeLabel":"object | null"},"platform_services":{"oneOf":[{"type":"object","description":"Required only for key \"26\" (Plataformas Tecnológicas). Service details for technology platform retentions. Header totals (IVA trasladado, ISR retenido, etc.) are auto-calculated.","required":["periodicity","services"],"properties":{"periodicity":{"type":"string","description":"Reporting periodicity: 01=Diario, 02=Semanal, 03=Quincenal, 04=Mensual, 05=Bimestral","example":"04","isRequired":true,"uniqueKey":"platform_services.oneOf.0.periodicity","typeLabel":"string"},"services":{"type":"array","description":"Individual service entries","items":{"type":"object","required":["payment_form","service_type","service_date","price_without_tax"],"properties":{"payment_form":{"type":"string","description":"Payment form: 01=Efectivo, 02=Transferencia, 03=Tarjeta débito, 04=Tarjeta crédito, 05=Monedero electrónico","example":"02","isRequired":true,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].payment_form","typeLabel":"string"},"service_type":{"type":"string","description":"Service type: 01=Transporte terrestre, 02=Entrega alimentos, 03=Hospedaje, 04=Otros","example":"01","isRequired":true,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].service_type","typeLabel":"string"},"service_date":{"type":"string","description":"Service date (YYYY-MM-DD)","example":"2026-01-15","isRequired":true,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].service_date","typeLabel":"string"},"price_without_tax":{"type":"number","description":"Service price without IVA","example":500,"isRequired":true,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].price_without_tax","typeLabel":"number"},"tax_rate":{"oneOf":[{"type":"number","description":"IVA tax rate (defaults to 0.16 = 16%)","example":0.16,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].tax_rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"IVA tax rate (defaults to 0.16 = 16%)","example":0.16,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].tax_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].tax_rate","typeLabel":"number | null"},"commission":{"oneOf":[{"type":"number","description":"Platform commission amount","example":125,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].commission.oneOf.0","typeLabel":"number"},{"type":"null","description":"Platform commission amount","example":125,"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].commission.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].commission","typeLabel":"number | null"},"government_contribution":{"oneOf":[{"type":"number","description":"Government contribution amount (if applicable)","uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].government_contribution.oneOf.0","typeLabel":"number"},{"type":"null","description":"Government contribution amount (if applicable)","uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].government_contribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX].government_contribution","typeLabel":"number | null"}},"uniqueKey":"platform_services.oneOf.0.services.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"platform_services.oneOf.0.services","typeLabel":"object[]"}},"uniqueKey":"platform_services.oneOf.0","typeLabel":"object"},{"type":"null","description":"Required only for key \"26\" (Plataformas Tecnológicas). Service details for technology platform retentions. Header totals (IVA trasladado, ISR retenido, etc.) are auto-calculated.","required":["periodicity","services"],"properties":{"periodicity":{"type":"string","description":"Reporting periodicity: 01=Diario, 02=Semanal, 03=Quincenal, 04=Mensual, 05=Bimestral","example":"04"},"services":{"type":"array","description":"Individual service entries","items":{"type":"object","required":["payment_form","service_type","service_date","price_without_tax"],"properties":{"payment_form":{"type":"string","description":"Payment form: 01=Efectivo, 02=Transferencia, 03=Tarjeta débito, 04=Tarjeta crédito, 05=Monedero electrónico","example":"02"},"service_type":{"type":"string","description":"Service type: 01=Transporte terrestre, 02=Entrega alimentos, 03=Hospedaje, 04=Otros","example":"01"},"service_date":{"type":"string","description":"Service date (YYYY-MM-DD)","example":"2026-01-15"},"price_without_tax":{"type":"number","description":"Service price without IVA","example":500},"tax_rate":{"oneOf":[{"type":"number","description":"IVA tax rate (defaults to 0.16 = 16%)","example":0.16},{"type":"null","description":"IVA tax rate (defaults to 0.16 = 16%)","example":0.16}]},"commission":{"oneOf":[{"type":"number","description":"Platform commission amount","example":125},{"type":"null","description":"Platform commission amount","example":125}]},"government_contribution":{"oneOf":[{"type":"number","description":"Government contribution amount (if applicable)"},{"type":"null","description":"Government contribution amount (if applicable)"}]}}}}},"uniqueKey":"platform_services.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform_services","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"plataformas_tecnologicas":{"title":"plataformas_tecnologicas","summary":"Plataformas Tecnológicas (key 26) — with services complement","description":"Digital platform retention (Uber, Rappi, etc.). Requires platform_services with service details. Header totals are auto-calculated from services and taxes.","value":{"retention_key":"26","client":{"id":"abc123clientId"},"period_start":1,"period_end":1,"period_year":2026,"total_operation":93116.98,"total_exempt":0,"taxes":[{"tax":"ISR","base":93116.98,"amount":2327.92},{"tax":"IVA","base":14898.71,"amount":7449.35}],"platform_services":{"periodicity":"04","services":[{"payment_form":"02","service_type":"01","service_date":"2026-01-10","price_without_tax":46558.49,"tax_rate":0.16,"commission":11639.62},{"payment_form":"02","service_type":"01","service_date":"2026-01-20","price_without_tax":46558.49,"tax_rate":0.16,"commission":11639.62}]}}},"intereses":{"title":"intereses","summary":"Intereses (key 16) — with interest complement","description":"Interest income retention. Requires the interest object with financial system details.","value":{"retention_key":"16","client":{"search":{"on_key":"tax_id","on_value":"BNK200101ABC","auto_create":false}},"period_start":1,"period_end":12,"period_year":2026,"total_operation":150000,"total_exempt":0,"taxes":[{"tax":"ISR","base":150000,"amount":3000}],"interest":{"financial_system":"SI","withdrawal_aores":"NO","financial_derivatives":"NO","nominal_interest":8500.5,"real_interest":5200.3,"loss":0}}},"honorarios_profesionales":{"title":"honorarios_profesionales","summary":"Honorarios profesionales (key 01) — ISR only","description":"Professional fees retention. Only ISR is withheld (typically 10% of the gross amount).","value":{"retention_key":"01","client":{"id":"client_professional_abc"},"period_start":1,"period_end":3,"period_year":2026,"total_operation":50000,"total_exempt":0,"taxes":[{"tax":"ISR","base":50000,"amount":5000}]}},"arrendamiento":{"title":"arrendamiento","summary":"Arrendamiento (key 02) — ISR + IVA","description":"Rental income retention. ISR (10%) and IVA (2/3 of IVA) are withheld.","value":{"retention_key":"02","client":{"id":"client_landlord_xyz"},"period_start":1,"period_end":1,"period_year":2026,"total_operation":30000,"total_exempt":0,"taxes":[{"tax":"ISR","base":30000,"amount":3000},{"tax":"IVA","base":4800,"amount":3200}]}},"with_exempt_and_metadata":{"title":"with_exempt_and_metadata","summary":"With exempt amount, series, and metadata","description":"Full example with all optional fields. Taxable amount is auto-calculated as total_operation minus total_exempt.","value":{"retention_key":"14","client":{"tax_id":"EMP200101ABC","legal_name":"EMPRESA EJEMPLO SA DE CV","address":{"zip":"06700","country":"MEX"}},"period_start":1,"period_end":6,"period_year":2026,"total_operation":100000,"total_exempt":20000,"taxes":[{"tax":"ISR","base":80000,"amount":8000},{"tax":"IVA","base":12800,"amount":8533.33}],"series":"RET-A","metadata":{"internal_ref":"Q1-2026-RETENTION","department":"finance"},"idempotency_key":"ret-2026-q1-client456"}},"otro_tipo_retenciones":{"title":"otro_tipo_retenciones","summary":"Otro tipo de retenciones (key 25) — with description","description":"Generic retention type. Requires retention_description to describe the type of retention.","value":{"retention_key":"25","client":{"id":"client_misc_abc"},"period_start":1,"period_end":6,"period_year":2026,"total_operation":40000,"total_exempt":0,"taxes":[{"tax":"ISR","base":40000,"amount":4000}],"retention_description":"Retención por servicios de consultoría especializada en seguridad informática"}},"isr_only_with_custom_payment_type":{"title":"isr_only_with_custom_payment_type","summary":"ISR with custom payment type override","description":"Override the default payment type. By default ISR uses \"03\" (provisional), but you can set it to \"01\" (definitivo) if needed.","value":{"retention_key":"01","client":{"id":"client_consultant_789"},"period_start":3,"period_end":3,"period_year":2026,"total_operation":25000,"taxes":[{"tax":"ISR","base":25000,"amount":2500,"payment_type":"01"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"516570c1-f52c-437f-a312-a578791bad8e":{"description":"Retention created and stamped successfully","content":{"application/json":{"schema":{"type":"object","description":"Standardized success envelope emitted by `sendSuccessResponse`.\n","required":["success","data","timestamp"],"properties":{"success":{"type":"boolean","enum":[true],"example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","description":"The operation payload.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"timestamp":{"type":"integer","format":"int64","description":"Server time in **epoch milliseconds** (`Luxon.now().toMillis()`).","example":1767225600000,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer\u003cint64>"},"message":{"type":"string","description":"Human-readable summary. Present only when the handler supplies one.","example":"Operation completed successfully","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"success":{"title":"success","summary":"Retention stamped successfully","value":{"message":"Retention created successfully","data":{"id":"9d9b0e5b-034c-42f7-bd21-3a868a57c13e","uuid":"9d9b0e5b-034c-42f7-bd21-3a868a57c13e","status":"valid","document_type":"retenciones","retention_key":"26","folio_number":"1","series":"RET","issuer":{"legal_name":"MI EMPRESA SA DE CV","tax_id":"MEE200101ABC","tax_system":"601"},"receiver":{"legal_name":"GRUPO JINIM","tax_id":"EKU9003173C9","nationality":"Nacional"},"period":{"start":1,"end":1,"year":2026},"totals":{"total_operation":93116.98,"total_taxable":93116.98,"total_exempt":0,"total_retained":9777.27,"tax_retained":[{"tax":"001","base":93116.98,"amount":2327.92,"payment_type":"03"},{"tax":"002","base":14898.71,"amount":7449.35,"payment_type":"01"}]},"stamp":{"uuid":"9d9b0e5b-034c-42f7-bd21-3a868a57c13e","stamped_at":"2026-01-15T10:30:45.000Z"},"verification_url":"https://verificacfdi.facturaelectronica.sat.gob.mx/default.aspx?id=9d9b0e5b-034c-42f7-bd21-3a868a57c13e\u0026re=MEE200101ABC\u0026rr=EKU9003173C9\u0026tt=93116.98\u0026fe=abcd1234","livemode":true,"created_at":1736942445000,"metadata":null},"success":true,"timestamp":1767225600000}}},"exampleType":"examples"}},"exampleType":"examples"},"7cb87ba3-e76b-498e-807a-8cfe0e92b722":{"description":"Bad request or stamping error","content":{"application/json":{"schema":{"type":"object","description":"Body validation failure. Unknown top-level keys are rejected — the validator runs in\nstrict allowlist mode (`allowUnknown: false`), so a field not declared in the request\nschema produces an `unexpected_key` detail rather than being ignored.\n","required":["success","error","timestamp"],"example":{"success":false,"error":{"code":"validation_failed","message":"Request validation failed","details":["currency: Field is required","client_id: Unexpected field"]},"timestamp":1767225600000},"properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code. Values emitted by the shared helpers:\n`unauthorized`, `forbidden`, `invalid_token`, `validation_failed`,\n`invalid_request_body`, `missing_required_field`, `invalid_field_value`,\n`resource_not_found`, `resource_already_exists`, `resource_conflict`,\n`business_rule_violation`, `operation_not_allowed`,\n`insufficient_permissions`, `external_service_error`,\n`payment_processor_error`, `cfdi_service_error`,\n`internal_server_error`, `service_unavailable`, `rate_limit_exceeded`,\n`database_error`, `data_integrity_error`, `file_not_found`,\n`file_upload_error`, `invalid_file_format`. Individual handlers may\nemit additional endpoint-specific codes, documented per operation.\n","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Request validation failed","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"error.details.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"error.details.oneOf.1","typeLabel":"string[]"},{"type":"object","description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"error.details.oneOf.2","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | string[] | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"timestamp":{"type":"integer","format":"int64","description":"Server time in epoch milliseconds.","example":1767225600000,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer\u003cint64>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"validation_error":{"title":"validation_error","summary":"Missing required fields","value":{"error":{"code":"bad_request","message":"retention_key: Missing required field; taxes: Missing required field"},"success":false,"timestamp":1767225600000}},"client_not_found":{"title":"client_not_found","summary":"Client ID not found","value":{"error":{"code":"bad_request","message":"Client not found: invalid_client_id"},"success":false,"timestamp":1767225600000}},"no_provider":{"title":"no_provider","summary":"No SAT provider configured","value":{"error":{"code":"bad_request","message":"No SAT provider configured for this team"},"success":false,"timestamp":1767225600000}},"stamping_error":{"title":"stamping_error","summary":"SAT stamping failed","value":{"error":{"code":"cfdi_service_error","message":"CFDI33184 - El valor del atributo RFC del receptor no existe en la lista de RFC inscritos no cancelados del SAT"},"success":false,"timestamp":1767225600000}}},"exampleType":"examples"}},"exampleType":"examples"},"6cd1b613-8ae1-4957-ab30-4d977b9107d3":{"description":"Authentication failed. Two different bodies can come back with a `401`:\n\n1. **From the authentication layer**, before the endpoint runs: a raw object with\n `message` and — for OAuth access tokens only — `error` / `error_description`. It does\n **not** use the standardized envelope (`success` and `timestamp` are absent). Messages:\n `Unauthorized` (missing header, missing `Bearer ` prefix, unparseable token),\n `Unauthorized, missing team in token`, `Unauthorized, not a master team` and\n `Unauthorized, no matched teams` (gigstack Connect), `Invalid access token`,\n `Access token has expired. Please refresh your token.`, `Access token has been revoked`.\n2. **From the endpoint itself**: the standardized envelope with `error.code: unauthorized`.\n\nBranch on the HTTP status, not on the body shape.\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Raw error body produced by the authentication layer (before any endpoint runs). It is not\nthe standardized envelope: there is no `success` and no `timestamp`.\n","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable reason. Some messages are in Spanish; branch on the HTTP status, not on this text.","example":"Unauthorized","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"error":{"type":"string","description":"OAuth error code. Present only when an OAuth access token was presented.","enum":["invalid_token","token_expired","token_revoked","server_error"],"example":"token_expired","uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"error_description":{"type":"string","description":"Same text as `message`. Present only alongside `error`.","example":"Access token has expired. Please refresh your token.","uniqueKey":"oneOf.0.error_description","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Extra detail, e.g. `Invalid API Key` when a revoked key is rejected with `403`.","example":"Invalid API Key","uniqueKey":"oneOf.0.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Extra detail, e.g. `Invalid API Key` when a revoked key is rejected with `403`.","example":"Invalid API Key","uniqueKey":"oneOf.0.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.details","typeLabel":"string | object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Standardized error envelope emitted by `sendErrorResponse` and its helpers\n(`sendValidationError`, `sendNotFoundError`, `sendUnauthorizedError`,\n`sendForbiddenError`, `sendConflictError`, `sendBadRequestError`,\n`sendInternalServerError`).\n","required":["success","error","timestamp"],"example":{"success":false,"error":{"code":"unauthorized","message":"Unauthorized access"},"timestamp":1767225600000},"properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"oneOf.1.success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code. Values emitted by the shared helpers:\n`unauthorized`, `forbidden`, `invalid_token`, `validation_failed`,\n`invalid_request_body`, `missing_required_field`, `invalid_field_value`,\n`resource_not_found`, `resource_already_exists`, `resource_conflict`,\n`business_rule_violation`, `operation_not_allowed`,\n`insufficient_permissions`, `external_service_error`,\n`payment_processor_error`, `cfdi_service_error`,\n`internal_server_error`, `service_unavailable`, `rate_limit_exceeded`,\n`database_error`, `data_integrity_error`, `file_not_found`,\n`file_upload_error`, `invalid_file_format`. Individual handlers may\nemit additional endpoint-specific codes, documented per operation.\n","example":"validation_failed","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","example":"Request validation failed","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"oneOf.1.error.details.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.error.details.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"oneOf.1.error.details.oneOf.1","typeLabel":"string[]"},{"type":"object","description":"Present only when the handler supplies detail. Validation failures\nemit an array of `\"\u003cfield path>: \u003cmessage>\"` strings. An object only\nwhere an operation documents its keys: account billing answers `409`\n`billing_operation_pending` with `{ \"operation_id\": \"\u003cid>\" }`, the\noperation holding the account lock, to reconcile\n(`POST /teams/{id}/billing/operations/{operationId}/reconcile`).\n","example":["currency: Field is required"],"uniqueKey":"oneOf.1.error.details.oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.1.error.details","typeLabel":"string | string[] | object"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"},"timestamp":{"type":"integer","format":"int64","description":"Server time in epoch milliseconds.","example":1767225600000,"isRequired":true,"uniqueKey":"oneOf.1.timestamp","typeLabel":"integer\u003cint64>"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"missing_or_invalid_key":{"title":"missing_or_invalid_key","summary":"Authentication layer — missing or unparseable API key","value":{"message":"Unauthorized"}},"oauth_token_expired":{"title":"oauth_token_expired","summary":"Authentication layer — expired OAuth access token","value":{"message":"Access token has expired. Please refresh your token.","error":"token_expired","error_description":"Access token has expired. Please refresh your token."}},"connect_not_master_team":{"title":"connect_not_master_team","summary":"Authentication layer — `team` sent by a team without gigstack Connect","value":{"message":"Unauthorized, not a master team"}},"endpoint_envelope":{"title":"endpoint_envelope","summary":"Endpoint — standardized envelope","value":{"success":false,"error":{"code":"unauthorized","message":"Unauthorized access"},"timestamp":1767225600000}}},"exampleType":"examples"}},"exampleType":"examples"},"417bb6ae-2356-4c43-8515-6b3bd9ae74c9":{"description":"Rejected by the authentication layer after the credential was recognised. The body is a raw\nobject (`message`, sometimes `details`), **not** the standardized envelope. Causes:\n\n- The API key was revoked or disabled: `message: \"API Key inválida.\"`, `details: \"Invalid API Key\"`.\n- Legacy plans only: the billing account's plan does not include API access. `message` is a\n Spanish sentence containing an HTML link to `https://app.gigstack.pro/memberships`. Branch on\n the status code; do not display or match the text. Pricing v3 accounts always have API access.\n- gigstack Connect: the account lacks gigstack Connect (Pricing v3) or its legacy plan lacks the\n `multipleIssuerAccounts` feature (Spanish message; on Pricing v3 it starts `Tu cuenta no\n tiene gigstack Connect`, on legacy plans `Tu plan no incluye múltiples cuentas emisoras.`), or\n an OAuth access token was\n sent with a `team` other than its own (`Team mismatch with OAuth token`).\n\nAn endpoint may also answer `403` for its own reasons; those are documented on the\noperation when they exist.\n","content":{"application/json":{"schema":{"type":"object","description":"Raw error body produced by the authentication layer (before any endpoint runs). It is not\nthe standardized envelope: there is no `success` and no `timestamp`.\n","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable reason. Some messages are in Spanish; branch on the HTTP status, not on this text.","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"OAuth error code. Present only when an OAuth access token was presented.","enum":["invalid_token","token_expired","token_revoked","server_error"],"example":"token_expired","uniqueKey":"error","typeLabel":"enum\u003cstring>"},"error_description":{"type":"string","description":"Same text as `message`. Present only alongside `error`.","example":"Access token has expired. Please refresh your token.","uniqueKey":"error_description","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Extra detail, e.g. `Invalid API Key` when a revoked key is rejected with `403`.","example":"Invalid API Key","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Extra detail, e.g. `Invalid API Key` when a revoked key is rejected with `403`.","example":"Invalid API Key","uniqueKey":"details.oneOf.1","typeLabel":"object"}],"uniqueKey":"details","typeLabel":"string | object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"revoked_api_key":{"title":"revoked_api_key","summary":"API key revoked or disabled","value":{"message":"API Key inválida.","details":"Invalid API Key"}},"plan_without_api_access":{"title":"plan_without_api_access","summary":"Plan does not include API access","value":{"message":"La API se encuentra disponible para un plan más grande, por favor actualiza tu plan \u003ca href='https://app.gigstack.pro/memberships'>aquí\u003c/a> o ponte en contacto con soporte."}},"connect_plan_without_multiple_issuers":{"title":"connect_plan_without_multiple_issuers","summary":"gigstack Connect — plan lacks multipleIssuerAccounts","value":{"message":"Tu plan no incluye múltiples cuentas emisoras. Actualiza tu plan en https://app.gigstack.pro/memberships o ponte en contacto con soporte para operar sobre otros equipos."}},"connect_v3_without_connect":{"title":"connect_v3_without_connect","summary":"gigstack Connect — Pricing v3 account without gigstack Connect","value":{"message":"Tu cuenta no tiene gigstack Connect, que incluye múltiples cuentas emisoras. Actívalo en Ajustes > General > Facturación (https://app.gigstack.pro/settings?tab=general\u0026subtab=billing) o ponte en contacto con soporte para operar sobre otros equipos."}},"oauth_team_mismatch":{"title":"oauth_team_mismatch","summary":"gigstack Connect — OAuth token used for another team","value":{"message":"Team mismatch with OAuth token"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4be1f963-09bb-4e33-a71b-1174e05da64e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Authentication Method:** HTTP Bearer token.\n\nThe runtime requires the literal `Bearer ` prefix — a bare token in the\n`Authorization` header is rejected with `401 unauthorized`.\n\n**Header Format:** `Authorization: Bearer YOUR_API_KEY`\n\nYour API key is a JWT. Live keys operate on live data (`livemode: true`);\ntest keys operate on isolated test data (`livemode: false`).\n\n**Get your key at:** [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)\n\n**Errors:** credential failures are answered by the authentication layer with a raw\n`{ \"message\": … }` body, not the standardized envelope — `401` for a missing, malformed or\nexpired token, `403` for a revoked key or a plan without API access. See the `Unauthorized`\nand `AuthForbidden` responses.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"aab38087-9d60-4eb4-b6c9-2a7ae8d53a00":{"url":"https://api.gigstack.io/v2","description":"Public API for standard live and test-mode keys. Test data is isolated by the key mode\n(`livemode: false`). Internal staging is a separate deployment and key store; see\nhttps://docs.gigstack.io/authentication#environments for its base URL.\n"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Authentication Method:** HTTP Bearer token.\n\nThe runtime requires the literal `Bearer ` prefix — a bare token in the\n`Authorization` header is rejected with `401 unauthorized`.\n\n**Header Format:** `Authorization: Bearer YOUR_API_KEY`\n\nYour API key is a JWT. Live keys operate on live data (`livemode: true`);\ntest keys operate on isolated test data (`livemode: false`).\n\n**Get your key at:** [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)\n\n**Errors:** credential failures are answered by the authentication layer with a raw\n`{ \"message\": … }` body, not the standardized envelope — `401` for a missing, malformed or\nexpired token, `403` for a revoked key or a plan without API access. See the `Unauthorized`\nand `AuthForbidden` responses.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"**Authentication Method:** HTTP Bearer token.\n\nThe runtime requires the literal `Bearer ` prefix — a bare token in the\n`Authorization` header is rejected with `401 unauthorized`.\n\n**Header Format:** `Authorization: Bearer YOUR_API_KEY`\n\nYour API key is a JWT. Live keys operate on live data (`livemode: true`);\ntest keys operate on isolated test data (`livemode: false`).\n\n**Get your key at:** [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)\n\n**Errors:** credential failures are answered by the authentication layer with a raw\n`{ \"message\": … }` body, not the standardized envelope — `401` for a missing, malformed or\nexpired token, `403` for a revoked key or a plan without API access. See the `Unauthorized`\nand `AuthForbidden` responses.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"gigstack-736714cc","siteName":"gigstack","title":"Create retention - gigstack","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T15:33:24.596Z","originalFileLocation":"reference/createRetentions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create and stamp a new tax retention document (CFDI Retenciones 2.0). The API accepts a simplified format — the backend handles: - Client lookup by ID (fetches RFC, legal name, address automatically) - Nationality detection from client\u0026#x27;s country - Tax code mapping (ISR → 001, IVA → 002, IEPS → 003) - Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo) - Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes) - Folio auto-generation - SAT stamping, PDF and XML generation gigstack Connect: Create retentions for other teams using the team parameter. ## Conditional requirements per retention_key retention_key is validated as a free-form string — any SAT key is accepted — but three keys carry extra requirements enforced before the document is stamped. A violation returns 400 with error.code: invalid_request_body and the message quoted below. | retention_key | additional requirement | error message on violation | |---|---|---| | 16 — Intereses | interest object is required | interest object is required for retention key 16 (Intereses) | | 25 — Otro tipo de retenciones | retention_description is required and non-empty | retention_description is required for retention key 25 (Otro tipo de retenciones) | | 26 — Plataformas Tecnológicas | platform_services object is required and taxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS) | platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas | Every other key requires only the base fields (retention_key, client, period_start, period_end, period_year, total_operation, taxes). Within interest, financial_system, nominal_interest and real_interest are required. Within platform_services, periodicity and services are required, and each entry in services requires payment_form, service_type, service_date and price_without_tax. \u0026gt; Unlike the other modules, this endpoint strips unknown keys instead of rejecting \u0026gt; them (stripUnknown: true), so an undeclared field is silently discarded rather than \u0026gt; returning 400.\">\u003cmeta data-mint-head name=\"application-name\" content=\"gigstack\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create retention - gigstack\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create and stamp a new tax retention document (CFDI Retenciones 2.0). The API accepts a simplified format — the backend handles: - Client lookup by ID (fetches RFC, legal name, address automatically) - Nationality detection from client\u0026#x27;s country - Tax code mapping (ISR → 001, IVA → 002, IEPS → 003) - Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo) - Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes) - Folio auto-generation - SAT stamping, PDF and XML generation gigstack Connect: Create retentions for other teams using the team parameter. ## Conditional requirements per retention_key retention_key is validated as a free-form string — any SAT key is accepted — but three keys carry extra requirements enforced before the document is stamped. A violation returns 400 with error.code: invalid_request_body and the message quoted below. | retention_key | additional requirement | error message on violation | |---|---|---| | 16 — Intereses | interest object is required | interest object is required for retention key 16 (Intereses) | | 25 — Otro tipo de retenciones | retention_description is required and non-empty | retention_description is required for retention key 25 (Otro tipo de retenciones) | | 26 — Plataformas Tecnológicas | platform_services object is required and taxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS) | platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas | Every other key requires only the base fields (retention_key, client, period_start, period_end, period_year, total_operation, taxes). Within interest, financial_system, nominal_interest and real_interest are required. Within platform_services, periodicity and services are required, and each entry in services requires payment_form, service_type, service_date and price_without_tax. \u0026gt; Unlike the other modules, this endpoint strips unknown keys instead of rejecting \u0026gt; them (stripUnknown: true), so an undeclared field is silently discarded rather than \u0026gt; returning 400.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"gigstack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gigstack.io/reference/createRetentions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gigstack-736714cc.mintlify.site/_mintlify/api/og/v2?division=Retentions\u0026amp;title=Create+retention\u0026amp;description=Create+and+stamp+a+new+tax+retention+document+%28CFDI+Retenciones+2.0%29.%0A%0AThe+API+accepts+a+**simplified+format**+%E2%80%94+the+backend+handles%3A%0A-+**Client+lookup**+by+ID+\u0026amp;theme=c8c9058b183856e8fedb0215\u0026amp;signature=4b282377573bdaa1a0db5213b35bf74a5f4db62e0428e7418312f3f424fe8593\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create retention - gigstack\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create and stamp a new tax retention document (CFDI Retenciones 2.0). The API accepts a simplified format — the backend handles: - Client lookup by ID (fetches RFC, legal name, address automatically) - Nationality detection from client\u0026#x27;s country - Tax code mapping (ISR → 001, IVA → 002, IEPS → 003) - Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo) - Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes) - Folio auto-generation - SAT stamping, PDF and XML generation gigstack Connect: Create retentions for other teams using the team parameter. ## Conditional requirements per retention_key retention_key is validated as a free-form string — any SAT key is accepted — but three keys carry extra requirements enforced before the document is stamped. A violation returns 400 with error.code: invalid_request_body and the message quoted below. | retention_key | additional requirement | error message on violation | |---|---|---| | 16 — Intereses | interest object is required | interest object is required for retention key 16 (Intereses) | | 25 — Otro tipo de retenciones | retention_description is required and non-empty | retention_description is required for retention key 25 (Otro tipo de retenciones) | | 26 — Plataformas Tecnológicas | platform_services object is required and taxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS) | platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas | Every other key requires only the base fields (retention_key, client, period_start, period_end, period_year, total_operation, taxes). Within interest, financial_system, nominal_interest and real_interest are required. Within platform_services, periodicity and services are required, and each entry in services requires payment_form, service_type, service_date and price_without_tax. \u0026gt; Unlike the other modules, this endpoint strips unknown keys instead of rejecting \u0026gt; them (stripUnknown: true), so an undeclared field is silently discarded rather than \u0026gt; returning 400.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gigstack-736714cc.mintlify.site/_mintlify/api/og/v2?division=Retentions\u0026amp;title=Create+retention\u0026amp;description=Create+and+stamp+a+new+tax+retention+document+%28CFDI+Retenciones+2.0%29.%0A%0AThe+API+accepts+a+**simplified+format**+%E2%80%94+the+backend+handles%3A%0A-+**Client+lookup**+by+ID+\u0026amp;theme=c8c9058b183856e8fedb0215\u0026amp;signature=4b282377573bdaa1a0db5213b35bf74a5f4db62e0428e7418312f3f424fe8593\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gigstack-736714cc/XxFE_5jrUgFYfbts/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"gigstack\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#527A16\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gigstack.io/reference/createRetentions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/createRetentions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gigstack.io/#organization\",\"name\":\"gigstack\",\"url\":\"https://docs.gigstack.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gigstack-736714cc/n52DA3e1uZaES4AD/logo/light.svg?fit=max\u0026auto=format\u0026n=n52DA3e1uZaES4AD\u0026q=85\u0026s=c2a76374f23410e1b668aa0f9c87e282\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gigstack.io#website\",\"name\":\"gigstack\",\"url\":\"https://docs.gigstack.io\",\"publisher\":{\"@id\":\"https://docs.gigstack.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gigstack.io/reference/createRetentions#webpage\",\"url\":\"https://docs.gigstack.io/reference/createRetentions\",\"name\":\"Create retention\",\"description\":\"Create and stamp a new tax retention document (CFDI Retenciones 2.0). The API accepts a simplified format — the backend handles: - Client lookup by ID (fetches RFC, legal name, address automatically) - Nationality detection from client's country - Tax code mapping (ISR → 001, IVA → 002, IEPS → 003) - Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo) - Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes) - Folio auto-generation - SAT stamping, PDF and XML generation gigstack Connect: Create retentions for other teams using the team parameter. ## Conditional requirements per retention_key retention_key is validated as a free-form string — any SAT key is accepted — but three keys carry extra requirements enforced before the document is stamped. A violation returns 400 with error.code: invalid_request_body and the message quoted below. | retention_key | additional requirement | error message on violation | |---|---|---| | 16 — Intereses | interest object is required | interest object is required for retention key 16 (Intereses) | | 25 — Otro tipo de retenciones | retention_description is required and non-empty | retention_description is required for retention key 25 (Otro tipo de retenciones) | | 26 — Plataformas Tecnológicas | platform_services object is required and taxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS) | platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas | Every other key requires only the base fields (retention_key, client, period_start, period_end, period_year, total_operation, taxes). Within interest, financial_system, nominal_interest and real_interest are required. Within platform_services, periodicity and services are required, and each entry in services requires payment_form, service_type, service_date and price_without_tax. > Unlike the other modules, this endpoint strips unknown keys instead of rejecting > them (stripUnknown: true), so an undeclared field is silently discarded rather than > returning 400.\",\"dateModified\":\"2026-10-08T15:33:24.596Z\",\"isPartOf\":{\"@id\":\"https://docs.gigstack.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gigstack.io/reference/createRetentions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gigstack.io/reference/createRetentions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core resources\",\"item\":\"https://docs.gigstack.io/reference/createClients\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create retention\",\"item\":\"https://docs.gigstack.io/reference/createRetentions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gigstack.io/reference/createRetentions#apireference\",\"headline\":\"Create retention\",\"name\":\"Create retention\",\"description\":\"Create and stamp a new tax retention document (CFDI Retenciones 2.0). The API accepts a simplified format — the backend handles: - Client lookup by ID (fetches RFC, legal name, address automatically) - Nationality detection from client's country - Tax code mapping (ISR → 001, IVA → 002, IEPS → 003) - Payment type defaults per tax (ISR → provisional, IVA/IEPS → definitivo) - Totals auto-calculation (taxable = operation − exempt, retained = sum of taxes) - Folio auto-generation - SAT stamping, PDF and XML generation gigstack Connect: Create retentions for other teams using the team parameter. ## Conditional requirements per retention_key retention_key is validated as a free-form string — any SAT key is accepted — but three keys carry extra requirements enforced before the document is stamped. A violation returns 400 with error.code: invalid_request_body and the message quoted below. | retention_key | additional requirement | error message on violation | |---|---|---| | 16 — Intereses | interest object is required | interest object is required for retention key 16 (Intereses) | | 25 — Otro tipo de retenciones | retention_description is required and non-empty | retention_description is required for retention key 25 (Otro tipo de retenciones) | | 26 — Plataformas Tecnológicas | platform_services object is required and taxes must contain at least one entry whose tax is not IVA (i.e. ISR or IEPS) | platform_services object is required for retention key 26 (Plataformas Tecnológicas) / At least one non-IVA tax (ISR or IEPS) is required for Plataformas Tecnológicas | Every other key requires only the base fields (retention_key, client, period_start, period_end, period_year, total_operation, taxes). Within interest, financial_system, nominal_interest and real_interest are required. Within platform_services, periodicity and services are required, and each entry in services requires payment_form, service_type, service_date and price_without_tax. > Unlike the other modules, this endpoint strips unknown keys instead of rejecting > them (stripUnknown: true), so an undeclared field is silently discarded rather than > returning 400.\",\"url\":\"https://docs.gigstack.io/reference/createRetentions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gigstack.io/reference/createRetentions#webpage\"},\"dateModified\":\"2026-10-08T15:33:24.596Z\",\"publisher\":{\"@id\":\"https://docs.gigstack.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gigstack.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"gigstack\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"gigstack\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/createRetentions.md","siteName":"gigstack","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Core resources","pages":[{"group":"Clients","expanded":true,"pages":[{"openapi":"openapi.json POST /clients","title":"Create client","href":"/reference/createClients"},{"openapi":"openapi.json GET /clients/{id}","title":"Get client","href":"/reference/getClientsById"},{"openapi":"openapi.json PUT /clients/{id}","title":"Update client","href":"/reference/updateClientsById"},{"openapi":"openapi.json DELETE /clients/{id}","title":"Delete client","href":"/reference/deleteClientsById"},{"openapi":"openapi.json GET /clients","title":"List clients","href":"/reference/listClients"},{"openapi":"openapi.json GET /clients/search","title":"Search clients","href":"/reference/getClientsSearch"},{"openapi":"openapi.json POST /clients/{id}/validate","title":"Validate client fiscal information","href":"/reference/validateClientById"},{"openapi":"openapi.json POST /clients/csf","title":"Upload CSF PDF to create or update client","href":"/reference/createClientsCsf"},{"openapi":"openapi.json POST /clients/{id}/stamp-pending-receipts","title":"Stamp pending receipts","href":"/reference/stampClientPendingReceipts"},{"openapi":"openapi.json POST /clients/validate/{id}","deprecated":true,"title":"Validate client fiscal information (deprecated path)","href":"/reference/createClientsValidateById"},{"openapi":"openapi.json POST /clients/customerportal","deprecated":true,"title":"Get client customer portal access token","href":"/reference/createClientsCustomerportal"},{"group":"Support documents","pages":[{"openapi":"openapi.json GET /clients/{id}/support-documents","title":"List a client's support documents","href":"/reference/getClientsByIdSupportDocuments"},{"openapi":"openapi.json POST /clients/{id}/support-documents","title":"Upload a client support document","href":"/reference/createClientsByIdSupportDocuments"}]}]},{"group":"Services","expanded":true,"pages":[{"openapi":"openapi.json POST /services","title":"Create service","href":"/reference/createServices"},{"openapi":"openapi.json GET /services/{id}","title":"Get service","href":"/reference/getServicesById"},{"openapi":"openapi.json PUT /services/{id}","title":"Update service","href":"/reference/updateServicesById"},{"openapi":"openapi.json DELETE /services/{id}","title":"Delete service","href":"/reference/deleteServicesById"},{"openapi":"openapi.json GET /services","title":"List services","href":"/reference/listServices"}]},{"group":"Invoices","expanded":true,"pages":[{"openapi":"openapi.json GET /invoices/{id}","title":"Get invoice","href":"/reference/getInvoiceById"},{"openapi":"openapi.json GET /invoices/search","title":"Search invoices","href":"/reference/getInvoicesSearch"},{"openapi":"openapi.json GET /invoices/errors","title":"List CFDI errors","href":"/reference/getInvoicesErrors"},{"openapi":"openapi.json GET /invoices/{id}/files","title":"Get invoice files","href":"/reference/getInvoicesByIdFiles"},{"openapi":"openapi.json POST /invoices/{id}/send","title":"Resend invoice email","href":"/reference/createInvoicesByIdSend"},{"openapi":"openapi.json PUT /invoices/{id}/pdf-details","title":"Edit an invoice's PDF notes and fields (Colombia)","href":"/reference/updateInvoicesByIdPdfDetails"},{"openapi":"openapi.json POST /invoices/{id}/cancel","title":"Cancel invoice","href":"/reference/cancelInvoiceById"},{"openapi":"openapi.json POST /invoices/eom/run","title":"Trigger end-of-month global invoicing","href":"/reference/runEndOfMonthInvoicing"},{"openapi":"openapi.json DELETE /invoices/{id}","deprecated":true,"title":"Cancel invoice (deprecated DELETE)","href":"/reference/cancelInvoice"},{"group":"Income invoices","pages":[{"openapi":"openapi.json POST /invoices/income","title":"Create income invoice","href":"/reference/createInvoicesIncome"},{"openapi":"openapi.json GET /invoices/income/{id}","title":"Get income invoice","href":"/reference/getInvoicesIncomeById"},{"openapi":"openapi.json GET /invoices/income","title":"List income invoices","href":"/reference/getInvoicesIncome"}]},{"group":"Egress invoices","pages":[{"openapi":"openapi.json POST /invoices/egress","title":"Create egress invoice","href":"/reference/createInvoicesEgress"},{"openapi":"openapi.json GET /invoices/egress/{id}","title":"Get egress invoice","href":"/reference/getInvoicesEgressById"},{"openapi":"openapi.json GET /invoices/egress","title":"List egress invoices","href":"/reference/getInvoicesEgress"}]},{"group":"Payment complements","pages":[{"openapi":"openapi.json POST /invoices/payment","title":"Create payment complement (complemento de pago)","href":"/reference/createInvoicesPayment"},{"openapi":"openapi.json GET /invoices/payment/{id}","title":"Get payment complement invoice","href":"/reference/getInvoicesPaymentById"},{"openapi":"openapi.json GET /invoices/payment","title":"List payment complement invoices","href":"/reference/getInvoicesPayment"}]},{"group":"Transfer invoices (Carta Porte)","pages":[{"openapi":"openapi.json POST /invoices/transfer","title":"Create transfer invoice (Carta Porte)","href":"/reference/postInvoicesTransfer"},{"openapi":"openapi.json GET /invoices/transfer/{id}","title":"Get transfer invoice","href":"/reference/getInvoicesTransferById"},{"openapi":"openapi.json GET /invoices/transfer","title":"List transfer invoices","href":"/reference/getInvoicesTransfer"}]},{"group":"Draft invoices","pages":[{"openapi":"openapi.json POST /invoices/draft","title":"Create draft invoice (pre-factura)","href":"/reference/createInvoicesDraft"},{"openapi":"openapi.json GET /invoices/draft/{id}","title":"Get draft invoice","href":"/reference/getInvoicesDraftById"},{"openapi":"openapi.json PUT /invoices/draft/{id}","title":"Update draft invoice","href":"/reference/updateInvoicesDraftById"},{"openapi":"openapi.json DELETE /invoices/draft/{id}","title":"Delete draft invoice","href":"/reference/deleteInvoicesDraftById"},{"openapi":"openapi.json GET /invoices/draft","title":"List draft invoices","href":"/reference/getInvoicesDraft"},{"openapi":"openapi.json POST /invoices/draft/{id}/stamp","title":"Stamp draft invoice (finalize)","href":"/reference/createInvoicesDraftByIdStamp"},{"openapi":"openapi.json POST /invoices/draft/{id}/preview","title":"Generate draft preview PDF (pre-factura)","href":"/reference/createInvoicesDraftByIdPreview"}]},{"group":"Invoice batches","pages":[{"openapi":"openapi.json POST /invoices/income/batch","title":"Create a batch of income invoices","href":"/reference/createIncomeInvoiceBatch"},{"openapi":"openapi.json GET /invoices/income/batch/{id}","title":"Get an income invoice batch","href":"/reference/getIncomeInvoiceBatch"},{"openapi":"openapi.json GET /invoices/income/batch/{id}/items","title":"List the items of an income invoice batch","href":"/reference/listIncomeInvoiceBatchItems"}]},{"group":"Support documents","pages":[{"openapi":"openapi.json GET /invoices/{id}/support-documents","title":"List an invoice's support documents","href":"/reference/getInvoicesByIdSupportDocuments"},{"openapi":"openapi.json POST /invoices/{id}/support-documents","title":"Upload an invoice support document","href":"/reference/createInvoicesByIdSupportDocuments"}]}]},{"group":"Receipts","expanded":true,"pages":[{"openapi":"openapi.json POST /receipts","title":"Create receipt","href":"/reference/createReceipts"},{"openapi":"openapi.json GET /receipts/{id}","title":"Get receipt","href":"/reference/getReceiptsById"},{"openapi":"openapi.json GET /receipts","title":"List receipts","href":"/reference/listReceipts"},{"openapi":"openapi.json GET /receipts/search","title":"Search receipts","href":"/reference/getReceiptsSearch"},{"openapi":"openapi.json POST /receipts/from-payments","title":"Create receipts for paid payments","href":"/reference/createReceiptsFromPayments"},{"openapi":"openapi.json POST /receipts/{id}/cancel","title":"Cancel receipt","href":"/reference/cancelReceiptById"},{"openapi":"openapi.json POST /receipts/{id}/stamp","title":"Stamp receipt","href":"/reference/createReceiptsByIdStamp"},{"openapi":"openapi.json POST /receipts/{id}/reopen","title":"Reopen receipt","href":"/reference/createReceiptsByIdReopen"},{"openapi":"openapi.json DELETE /receipts/{id}","deprecated":true,"title":"Cancel receipt (deprecated DELETE)","href":"/reference/deleteReceiptsById"}]},{"group":"Payments","expanded":true,"pages":[{"openapi":"openapi.json POST /payments/request","title":"Request payment (you want to get paid)","href":"/reference/createPaymentsRequest"},{"openapi":"openapi.json POST /payments/register","title":"Register payment (you were already paid)","href":"/reference/createPaymentsRegister"},{"openapi":"openapi.json POST /payments/register/batch","title":"Register a batch of payments","href":"/reference/createPaymentRegisterBatch"},{"openapi":"openapi.json GET /payments/{id}","title":"Get payment","href":"/reference/getPaymentsById"},{"openapi":"openapi.json GET /payments/register/batch/{id}","title":"Get a payment batch","href":"/reference/getPaymentRegisterBatch"},{"openapi":"openapi.json PUT /payments/{id}","title":"Update payment","href":"/reference/updatePaymentsById"},{"openapi":"openapi.json GET /payments","title":"List payments","href":"/reference/listPayments"},{"openapi":"openapi.json GET /payments/search","title":"Search payments","href":"/reference/getPaymentsSearch"},{"openapi":"openapi.json GET /payments/register/batch/{id}/items","title":"List the items of a payment batch","href":"/reference/listPaymentRegisterBatchItems"},{"openapi":"openapi.json POST /payments/{id}/cancel","title":"Cancel payment","href":"/reference/cancelPaymentById"},{"openapi":"openapi.json POST /payments/{id}/paid","title":"Mark payment as paid","href":"/reference/createPaymentsByIdPaid"},{"openapi":"openapi.json POST /payments/{id}/refund","title":"Refund payment","href":"/reference/createPaymentsByIdRefund"},{"openapi":"openapi.json DELETE /payments/{id}","deprecated":true,"title":"Cancel payment (deprecated DELETE)","href":"/reference/deletePaymentsById"},{"group":"Payment links","pages":[{"openapi":"openapi.json POST /payments/links","title":"Create reusable payment link","href":"/reference/createPaymentLink"},{"openapi":"openapi.json GET /payments/links/{linkId}","title":"Get reusable payment link","href":"/reference/getPaymentLink"},{"openapi":"openapi.json GET /payments/links/{linkId}/history/{resourceType}/{resourceId}","title":"Read an authorized historical invoice or receipt","href":"/reference/getPaymentLinkHistoryV2"},{"openapi":"openapi.json GET /payments/links/{linkId}/history/{resourceType}/{resourceId}/files/{fileType}","title":"Read an existing authorized historical PDF or XML","href":"/reference/getPaymentLinkHistoryFileV2"},{"openapi":"openapi.json GET /payments/links/operations/{operationId}","title":"Read payment-link operation","href":"/reference/getPaymentLinkOperation"},{"openapi":"openapi.json PATCH /payments/links/{linkId}","title":"Update reusable payment link","href":"/reference/updatePaymentLink"},{"openapi":"openapi.json DELETE /payments/links/{linkId}","title":"Delete reusable payment link","href":"/reference/deletePaymentLink"},{"openapi":"openapi.json GET /payments/links","title":"List reusable payment links","href":"/reference/listPaymentLinks"}]},{"group":"Reminders","pages":[{"openapi":"openapi.json GET /payments/{paymentId}/reminder-operations/{operationId}","title":"Get a payment reminder operation","href":"/reference/getPaymentReminderOperation"},{"openapi":"openapi.json GET /payments/{paymentId}/reminders","title":"Get payment reminder configuration","href":"/reference/getPaymentReminderConfiguration"},{"openapi":"openapi.json PUT /payments/{paymentId}/reminders","title":"Replace payment reminder configuration","href":"/reference/replacePaymentReminderConfiguration"},{"openapi":"openapi.json POST /payments/{paymentId}/reminder-operations/{operationId}/reconcile","title":"Reconcile a payment reminder operation","href":"/reference/reconcilePaymentReminderOperation"},{"openapi":"openapi.json POST /payments/{paymentId}/reminder-operations/{operationId}/continue","title":"Continue a payment reminder operation","href":"/reference/continuePaymentReminderOperation"},{"openapi":"openapi.json POST /payments/{paymentId}/reminder-recoveries","title":"Prepare a payment reminder recovery","href":"/reference/preparePaymentReminderRecovery"}]},{"group":"Support documents","pages":[{"openapi":"openapi.json GET /payments/{id}/support-documents","title":"List a payment's support documents","href":"/reference/getPaymentsByIdSupportDocuments"},{"openapi":"openapi.json POST /payments/{id}/support-documents","title":"Upload a payment support document","description":"Upload a supporting document (contract, proof of delivery, etc.) for a payment.\n\n**SAT 2026 Compliance:** The Mexican tax authority (SAT) can request supporting documentation\nto validate invoices and payments. This endpoint helps maintain compliance.\n\n**gigstack Connect:** Upload documents for other teams' payments using the `team` parameter.\n\n**Supported File Types:**\n- PDF files (.pdf)\n- Images (.png, .jpg, .jpeg, .webp)\n\n**File Size Limit:** 10MB\n\n**Document Types:**\n- `contract`: Service or product contracts\n- `delivery_proof`: Proof of delivery or service completion\n- `payment_proof`: Payment receipts or confirmations\n- `communication`: Emails, messages, or agreements\n- `payment_confirmation`: Payment processor confirmations\n- `subscription_info`: Subscription or recurring service details\n","href":"/reference/createPaymentsByIdSupportDocuments"}]}]},{"group":"Retentions","expanded":true,"pages":[{"openapi":"openapi.json POST /retentions","title":"Create retention","href":"/reference/createRetentions"},{"openapi":"openapi.json GET /retentions/{id}","title":"Get retention","description":"Retrieve a specific tax retention document by ID (UUID).\n\n**gigstack Connect:** View other teams' retentions using the `team` parameter.\n","href":"/reference/getRetentionsById"},{"openapi":"openapi.json GET /retentions","title":"List retentions","href":"/reference/listRetentions"},{"openapi":"openapi.json GET /retentions/{id}/files","title":"Get retention files","href":"/reference/getRetentionsByIdFiles"},{"openapi":"openapi.json POST /retentions/{id}/cancel","title":"Cancel retention","href":"/reference/cancelRetentionById"},{"openapi":"openapi.json DELETE /retentions/{id}","deprecated":true,"title":"Cancel retention (deprecated DELETE)","href":"/reference/deleteRetentionsById"}]}]},{"group":"SAT and fiscal tools","pages":[{"group":"SAT catalogs","expanded":false,"pages":[{"openapi":"openapi.json GET /catalogs/product-keys","title":"Search SAT product keys","href":"/reference/getCatalogsProductKeys"},{"openapi":"openapi.json GET /catalogs/unit-keys","title":"Search SAT unit keys","href":"/reference/getCatalogsUnitKeys"}]},{"group":"SAT lists","expanded":false,"pages":[{"openapi":"openapi.json GET /sat-lists/check/{rfc}","title":"Check an RFC against the SAT lists","href":"/reference/getSatListsCheckByRfc"},{"openapi":"openapi.json GET /sat-lists/32d/{rfc}","title":"Consult the SAT \"Opinión del Cumplimiento\" (32-D) for an RFC","href":"/reference/getSatOpinion32dByRfc"},{"openapi":"openapi.json GET /sat-lists","title":"List SAT lists and sync status","href":"/reference/listSatLists"}]},{"group":"SAT bulk download","expanded":false,"pages":[{"openapi":"openapi.json GET /invoices/sat/{uuid}","title":"Get a SAT invoice","href":"/reference/getSatInvoice"},{"openapi":"openapi.json GET /invoices/sat","title":"List SAT invoices","href":"/reference/listSatInvoices"},{"openapi":"openapi.json GET /invoices/download/ciec","title":"Get the CIEC connection status","href":"/reference/getInvoicesDownloadCiec"},{"openapi":"openapi.json POST /invoices/import","title":"Import CFDI XMLs the team already holds","href":"/reference/importInvoiceXml"},{"openapi":"openapi.json POST /invoices/sat/{uuid}/retry-xml","title":"Retry XML download","href":"/reference/retrySatXmlDownload"},{"openapi":"openapi.json POST /invoices/sat/{uuid}/pdf","title":"Generate PDF for a received SAT invoice","href":"/reference/generateSatPdf"},{"openapi":"openapi.json POST /invoices/download/ciec","title":"Connect with the SAT password (CIEC)","href":"/reference/createInvoicesDownloadCiec"},{"openapi":"openapi.json DELETE /invoices/download/ciec","title":"Disconnect the CIEC","href":"/reference/deleteInvoicesDownloadCiec"},{"group":"Setup","pages":[{"openapi":"openapi.json GET /invoices/download/activate/status","title":"Check activation status","href":"/reference/getInvoicesDownloadActivateStatus"},{"openapi":"openapi.json GET /invoices/download/debug","title":"Debug registration status","href":"/reference/getInvoicesDownloadDebug"},{"openapi":"openapi.json POST /invoices/download/activate","title":"Activate Descarga Masiva SAT","href":"/reference/createInvoicesDownloadActivate"},{"openapi":"openapi.json POST /invoices/download/deactivate","title":"Deactivate Descarga Masiva SAT","href":"/reference/createInvoicesDownloadDeactivate"},{"openapi":"openapi.json POST /invoices/download/fiel","title":"Upload FIEL credentials","href":"/reference/createInvoicesDownloadFiel"},{"openapi":"openapi.json POST /invoices/download/register","title":"Register business with SAT (manual)","href":"/reference/createInvoicesDownloadRegister"},{"openapi":"openapi.json POST /invoices/download/enable-sync","title":"Enable SAT sync","href":"/reference/createInvoicesDownloadEnableSync"},{"openapi":"openapi.json POST /invoices/download/pfx","title":"Connect FIEL credentials from a PFX file","href":"/reference/connectFielPfx"}]},{"group":"Schedule and sync","pages":[{"openapi":"openapi.json GET /invoices/download/schedule","title":"Get schedule configuration","href":"/reference/getInvoicesDownloadSchedule"},{"openapi":"openapi.json GET /invoices/download/schedule/history","title":"Get download request history","href":"/reference/getInvoicesDownloadScheduleHistory"},{"openapi":"openapi.json GET /invoices/download/progress","title":"Get SAT history sync progress","href":"/reference/getInvoicesDownloadProgress"},{"openapi":"openapi.json PUT /invoices/download/schedule","title":"Save schedule configuration","href":"/reference/updateInvoicesDownloadSchedule"},{"openapi":"openapi.json PUT /invoices/download/sync-period","title":"Update bulk-download sync period","href":"/reference/updateBulkDownloadSyncPeriod"}]},{"group":"Preview and import jobs","pages":[{"openapi":"openapi.json GET /invoices/download/jobs/{id}","title":"Get one job with per-window detail","href":"/reference/getInvoicesDownloadJob"},{"openapi":"openapi.json GET /invoices/download/jobs","title":"List recent preview and import jobs","href":"/reference/listInvoicesDownloadJobs"},{"openapi":"openapi.json POST /invoices/download/preview","title":"Preview a range of SAT history before paying for it","href":"/reference/createInvoicesDownloadPreview"},{"openapi":"openapi.json POST /invoices/download/jobs/{id}/cancel","title":"Stop a running job","href":"/reference/cancelInvoicesDownloadJob"},{"openapi":"openapi.json POST /invoices/download/import","title":"Download XMLs for chosen CFDIs","href":"/reference/importInvoicesDownload"}]},{"group":"Download requests","pages":[{"openapi":"openapi.json GET /invoices/download/status/{request_id}","title":"Check download request status","href":"/reference/getInvoicesDownloadStatusByRequestId"},{"openapi":"openapi.json GET /invoices/download/package/{package_id}","title":"Download XML package","href":"/reference/getInvoicesDownloadPackageByPackageId"},{"openapi":"openapi.json GET /invoices/download/invoice/{uuid}","title":"Get single invoice from SAT","href":"/reference/getInvoicesDownloadInvoiceByUuid"},{"openapi":"openapi.json POST /invoices/download/request","title":"Create bulk download request","href":"/reference/createInvoicesDownloadRequest"}]}]}]},{"group":"Automation and data","pages":[{"group":"Webhooks","expanded":false,"pages":[{"openapi":"openapi.json POST /webhooks","title":"Create webhook","href":"/reference/createWebhooks"},{"openapi":"openapi.json GET /webhooks/{id}","title":"Get webhook","href":"/reference/getWebhooksById"},{"openapi":"openapi.json PUT /webhooks/{id}","title":"Update webhook","href":"/reference/updateWebhooksById"},{"openapi":"openapi.json DELETE /webhooks/{id}","title":"Delete webhook","href":"/reference/deleteWebhooksById"},{"openapi":"openapi.json GET /webhooks","title":"List webhooks","href":"/reference/listWebhooks"},{"openapi":"openapi.json POST /webhooks/{id}/test","title":"Send a test event","href":"/reference/testManualWebhook"},{"openapi":"openapi.json POST /webhooks/{id}/resend-current","title":"Send current resource state","href":"/reference/resendCurrentWebhook"},{"group":"Deliveries","pages":[{"openapi":"openapi.json GET /teams/{id}/webhook-deliveries/{logId}","title":"Read one webhook delivery log","href":"/reference/getWebhookDeliveryLog"},{"openapi":"openapi.json GET /teams/{id}/webhook-deliveries","title":"List webhook delivery logs","href":"/reference/listWebhookDeliveryLogs"},{"openapi":"openapi.json POST /teams/{id}/webhook-deliveries/{logId}/retry","title":"Retry a stored webhook event","href":"/reference/retryWebhookDelivery"}]},{"group":"Operations","pages":[{"openapi":"openapi.json GET /webhooks/configuration-operations/{operationId}","title":"Read webhook configuration operation","href":"/reference/getWebhookConfigurationOperation"},{"openapi":"openapi.json GET /teams/{id}/webhook-operations/{operationId}","title":"Read a webhook operation","href":"/reference/getManualWebhookOperation"}]}]},{"group":"Journeys","expanded":false,"pages":[{"openapi":"openapi.json POST /journeys","title":"Create a draft journey","href":"/reference/createJourney"},{"openapi":"openapi.json GET /journeys/{id}","title":"Get a journey","href":"/reference/getJourney"},{"openapi":"openapi.json PUT /journeys/{id}","title":"Update a journey draft","href":"/reference/updateJourney"},{"openapi":"openapi.json DELETE /journeys/{id}","title":"Delete a draft or archived journey","href":"/reference/deleteJourney"},{"openapi":"openapi.json GET /journeys","title":"List journeys","href":"/reference/listJourneys"},{"openapi":"openapi.json GET /journeys/catalog","title":"Get the journey node catalog","href":"/reference/getJourneyCatalog"},{"openapi":"openapi.json GET /journeys/{id}/runs","title":"List the latest journey runs","href":"/reference/listJourneyRuns"},{"openapi":"openapi.json POST /journeys/{id}/publish","title":"Publish a journey","href":"/reference/publishJourney"},{"openapi":"openapi.json POST /journeys/{id}/pause","title":"Pause a journey","href":"/reference/pauseJourney"},{"openapi":"openapi.json POST /journeys/{id}/clone","title":"Clone a journey","href":"/reference/cloneJourney"},{"openapi":"openapi.json POST /journeys/{id}/test","title":"Queue a journey dry-run","href":"/reference/testJourney"}]},{"group":"Journey groups","expanded":false,"pages":[{"openapi":"openapi.json POST /journey-groups","title":"Create a journey group","href":"/reference/createJourneyGroup"},{"openapi":"openapi.json GET /journey-groups/{id}","title":"Get a journey group","href":"/reference/getJourneyGroup"},{"openapi":"openapi.json PUT /journey-groups/{id}","title":"Update the final membership of a journey group","href":"/reference/updateJourneyGroup"},{"openapi":"openapi.json GET /journey-groups","title":"List journey groups","href":"/reference/listJourneyGroups"},{"openapi":"openapi.json POST /journey-groups/{id}/clone","title":"Clone a journey group","href":"/reference/cloneJourneyGroup"},{"openapi":"openapi.json POST /journey-groups/{id}/revert","title":"Revert the latest group edit","href":"/reference/revertJourneyGroup"},{"openapi":"openapi.json POST /journey-groups/{id}/publish","title":"Publish journeys in a group","href":"/reference/publishJourneyGroup"},{"openapi":"openapi.json POST /journey-groups/{id}/pause","title":"Pause journeys in a group","href":"/reference/pauseJourneyGroup"}]},{"group":"Documents","expanded":false,"pages":[{"openapi":"openapi.json POST /documents","title":"Create document","href":"/reference/createDocument"},{"openapi":"openapi.json GET /documents/{id}","title":"Get document","href":"/reference/getDocument"},{"openapi":"openapi.json PATCH /documents/{id}","title":"Update document","href":"/reference/updateDocument"},{"openapi":"openapi.json DELETE /documents/{id}","title":"Delete document","href":"/reference/deleteDocument"},{"openapi":"openapi.json GET /documents","title":"List documents","href":"/reference/listDocuments"},{"openapi":"openapi.json POST /documents/{id}/analyze","title":"Analyze document with AI","href":"/reference/analyzeDocument"},{"openapi":"openapi.json POST /documents/{id}/link","title":"Link document to an entity","href":"/reference/linkDocument"},{"openapi":"openapi.json DELETE /documents/{id}/link","title":"Unlink document from an entity","href":"/reference/unlinkDocument"}]},{"group":"Google Sheets","expanded":false,"pages":[{"openapi":"openapi.json POST /sheets/connect","title":"Connect a Google spreadsheet","href":"/reference/connectSheets"},{"openapi":"openapi.json GET /sheets","title":"Get Google Sheets connection status","href":"/reference/getSheetsConnection"},{"openapi":"openapi.json GET /sheets/fields","title":"List mappable Google Sheets fields","href":"/reference/getSheetsFields"},{"openapi":"openapi.json GET /sheets/headers","title":"Refresh Google Sheets headers","href":"/reference/refreshSheetsHeaders"},{"openapi":"openapi.json GET /sheets/rows","title":"List the latest Google Sheets row outcomes","href":"/reference/listSheetsRows"},{"openapi":"openapi.json POST /sheets/disconnect","title":"Disconnect Google Sheets","href":"/reference/disconnectGoogleSheets"},{"openapi":"openapi.json PUT /sheets/mapping","title":"Save a Google Sheets import mapping","href":"/reference/updateSheetsMapping"},{"openapi":"openapi.json POST /sheets/preview","title":"Preview a Google Sheets import","href":"/reference/previewSheets"},{"openapi":"openapi.json POST /sheets/enable","title":"Enable Google Sheets imports","href":"/reference/enableSheets"},{"openapi":"openapi.json POST /sheets/pause","title":"Pause Google Sheets imports","href":"/reference/pauseSheets"},{"openapi":"openapi.json POST /sheets/sync","title":"Queue a Google Sheets sync","href":"/reference/syncSheets"},{"openapi":"openapi.json DELETE /sheets","deprecated":true,"title":"Disconnect Google Sheets (deprecated DELETE)","href":"/reference/disconnectSheets"}]},{"group":"Platform payouts","expanded":false,"pages":[{"openapi":"openapi.json POST /platform-payouts","title":"Upload files and plan a platform payouts run","href":"/reference/createPlatformPayoutRun"},{"openapi":"openapi.json GET /platform-payouts/{id}","title":"Get a platform payouts run","href":"/reference/getPlatformPayoutRun"},{"openapi":"openapi.json GET /platform-payouts/{id}/movements","title":"List a platform payouts run's movements","href":"/reference/listPlatformPayoutMovements"},{"openapi":"openapi.json POST /platform-payouts/{id}/confirm","title":"Confirm a platform payouts run for stamping","href":"/reference/confirmPlatformPayoutRun"}]}]},{"group":"Teams and access","pages":[{"group":"Teams","expanded":false,"pages":[{"openapi":"openapi.json POST /teams","title":"Create team","href":"/reference/createTeams"},{"openapi":"openapi.json GET /teams/{id}","title":"Get team","href":"/reference/getTeamsById"},{"openapi":"openapi.json PUT /teams/{id}","title":"Update team","href":"/reference/updateTeamsById"},{"openapi":"openapi.json DELETE /teams/{id}","title":"Delete team","href":"/reference/deleteTeamsById"},{"openapi":"openapi.json GET /teams","title":"List teams","href":"/reference/listTeams"},{"openapi":"openapi.json GET /teams/{id}/onboarding","title":"Get team onboarding status","href":"/reference/getTeamsByIdOnboarding"},{"openapi":"openapi.json POST /teams/{id}/deactivate","title":"Deactivate a business (dar de baja)","href":"/reference/deactivateTeam"},{"openapi":"openapi.json POST /teams/{id}/reactivate","title":"Reactivate a business","href":"/reference/reactivateTeam"},{"group":"Members","pages":[{"openapi":"openapi.json PATCH /teams/{id}/members/{memberId}","title":"Update member role or permissions","href":"/reference/updateTeamMember"},{"openapi":"openapi.json DELETE /teams/{id}/members/{memberId}","title":"Remove team member","href":"/reference/removeTeamMember"},{"openapi":"openapi.json GET /teams/{id}/members","title":"List team members","href":"/reference/listTeamMembers"},{"openapi":"openapi.json POST /teams/{id}/add-member","title":"Add team member","href":"/reference/createTeamsByIdAddMember"},{"openapi":"openapi.json POST /teams/{id}/remove-member","deprecated":true,"title":"Remove team member (deprecated)","href":"/reference/createTeamsByIdRemoveMember"},{"openapi":"openapi.json POST /teams/{id}/transfer-ownership","deprecated":true,"title":"Transfer team ownership","href":"/reference/transferTeamOwnership"}]},{"group":"Invitations","pages":[{"openapi":"openapi.json POST /teams/{id}/invitations","title":"Invite a member","href":"/reference/createTeamInvitation"},{"openapi":"openapi.json GET /teams/{id}/invitations/{inviteId}","title":"Get team invitation","href":"/reference/getTeamInvitation"},{"openapi":"openapi.json DELETE /teams/{id}/invitations/{inviteId}","title":"Revoke team invitation","href":"/reference/revokeTeamInvitation"},{"openapi":"openapi.json GET /teams/{id}/invitations","title":"List team invitations","href":"/reference/listTeamInvitations"},{"openapi":"openapi.json GET /teams/invitations/inbox","title":"List current recipient invitation inbox","href":"/reference/listRecipientInvitations"},{"openapi":"openapi.json POST /teams/{id}/invitations/{inviteId}/resend","title":"Resend invitation email","href":"/reference/resendTeamInvitation"},{"openapi":"openapi.json POST /teams/invitations/accept","title":"Accept team invitation","href":"/reference/acceptTeamInvitation"},{"openapi":"openapi.json POST /teams/invitations/decline","title":"Decline team invitation","href":"/reference/declineTeamInvitation"}]},{"group":"Configuration","pages":[{"openapi":"openapi.json POST /teams/{id}/series","title":"Create team series","href":"/reference/createTeamsByIdSeries"},{"openapi":"openapi.json PUT /teams/{id}/series/{seriesId}","title":"Update team series","href":"/reference/updateTeamsByIdSeriesBySeriesId"},{"openapi":"openapi.json GET /teams/{id}/series","title":"Get team series","href":"/reference/getTeamsByIdSeries"},{"openapi":"openapi.json GET /teams/{id}/email-templates","title":"Read email template defaults","href":"/reference/getTeamEmailTemplates"},{"openapi":"openapi.json GET /teams/{id}/settings","title":"Get team settings","href":"/reference/getTeamSettings"},{"openapi":"openapi.json GET /teams/{id}/onboarding-url","title":"Get team onboarding URL","href":"/reference/getTeamsByIdOnboardingUrl"},{"openapi":"openapi.json PUT /teams/{id}/settings","title":"Update team settings","href":"/reference/updateTeamsByIdSettings"},{"openapi":"openapi.json POST /teams/{id}/sat-connection","title":"Upload SAT CSD certificates","href":"/reference/createTeamsByIdSatConnection"},{"openapi":"openapi.json POST /teams/{id}/manifest/sign","title":"Sign manifest document","href":"/reference/createTeamsByIdManifestSign"},{"openapi":"openapi.json POST /teams/{id}/portal-access-token","deprecated":true,"title":"Create a portal access token","href":"/reference/createTeamsByIdPortalAccessToken"}]},{"group":"Portal operations","pages":[{"openapi":"openapi.json POST /teams/{id}/customer-portal-operations","title":"Prepare a customer portal operation","href":"/reference/prepareCustomerPortalOperation"},{"openapi":"openapi.json POST /teams/{id}/invoice-portal-operations","title":"Prepare an invoice portal operation","href":"/reference/prepareInvoicePortalOperation"},{"openapi":"openapi.json GET /teams/{id}/customer-portal-operations/{operationId}","title":"Get a customer portal operation","href":"/reference/getCustomerPortalOperation"},{"openapi":"openapi.json GET /teams/{id}/invoice-portal-operations/{operationId}","title":"Get an invoice portal operation","href":"/reference/getInvoicePortalOperation"},{"openapi":"openapi.json DELETE /teams/{id}/customer-portal-operations/{operationId}","title":"Cancel a customer portal operation","href":"/reference/cancelCustomerPortalOperation"},{"openapi":"openapi.json DELETE /teams/{id}/invoice-portal-operations/{operationId}","title":"Cancel an invoice portal operation","href":"/reference/cancelInvoicePortalOperation"}]},{"group":"Vendors","pages":[{"openapi":"openapi.json GET /teams/{id}/vendors/operations/{operationId}","title":"Read vendor creation operation","href":"/reference/getVendorCreationOperationV2"},{"openapi":"openapi.json GET /teams/{id}/vendors/{vendorId}/onboarding-capability","title":"Read safe vendor capability status","href":"/reference/getVendorOnboardingCapabilityV2"},{"openapi":"openapi.json POST /teams/{id}/vendors","title":"Create vendor account","href":"/reference/createVendorV2"}]},{"group":"API logs","pages":[{"openapi":"openapi.json GET /teams/{id}/api-logs/{logId}","title":"Read one API log","href":"/reference/getApiLog"},{"openapi":"openapi.json GET /teams/{id}/api-logs","title":"List API logs","href":"/reference/listApiLogs"}]}]},{"group":"Users","expanded":false,"pages":[{"openapi":"openapi.json POST /users","title":"Create user","href":"/reference/createUsers"},{"openapi":"openapi.json GET /users/{id}","title":"Get user","href":"/reference/getUsersById"},{"openapi":"openapi.json PUT /users/{id}","title":"Update user","href":"/reference/updateUsersById"},{"openapi":"openapi.json DELETE /users/{id}","title":"Remove a user from administered teams","href":"/reference/deleteUser"},{"openapi":"openapi.json GET /users","title":"List users","href":"/reference/listUsers"},{"openapi":"openapi.json POST /users/reset-password/{id}","deprecated":true,"title":"Retired direct password-reset email","href":"/reference/resetUserPassword"},{"openapi":"openapi.json POST /users/login-link","deprecated":true,"title":"Legacy direct login link (deprecated)","href":"/reference/createUsersLoginLink"},{"group":"Password reset","pages":[{"openapi":"openapi.json POST /users/{id}/password-reset-recoveries","title":"Prepare privately reviewed reset recovery","href":"/reference/preparePasswordResetRecovery"},{"openapi":"openapi.json POST /users/{id}/password-reset-operations","title":"Prepare one reset email","href":"/reference/preparePasswordResetOperation"},{"openapi":"openapi.json GET /users/{id}/password-reset-recoveries/{operationId}","title":"Read safe reset recovery status","href":"/reference/getPasswordResetRecovery"},{"openapi":"openapi.json GET /users/{id}/password-reset-operations/{operationId}","title":"Read saved reset email status","href":"/reference/getPasswordResetOperation"},{"openapi":"openapi.json DELETE /users/{id}/password-reset-operations/{operationId}","title":"Cancel an untouched reset preparation","href":"/reference/cancelPasswordResetOperation"},{"openapi":"openapi.json POST /users/{id}/password-reset-operations/{operationId}/execute","title":"Request the prepared reset email","href":"/reference/executePasswordResetOperation"}]}]},{"group":"Your account","expanded":false,"pages":[{"openapi":"openapi.json GET /users/me/preferences/{teamId}","title":"Read your team preferences","href":"/reference/getSelfPreferences"},{"openapi":"openapi.json PATCH /users/me/preferences/{teamId}","title":"Update your team preferences","href":"/reference/updateSelfPreferences"},{"openapi":"openapi.json GET /users/me","title":"Read your account profile","href":"/reference/getSelfProfile"},{"openapi":"openapi.json PATCH /users/me","title":"Update your account profile","href":"/reference/updateSelfProfile"},{"openapi":"openapi.json POST /users/me/active-context","title":"Select your active team or billing account","href":"/reference/selectSelfActiveContext"},{"group":"Notifications","pages":[{"openapi":"openapi.json DELETE /users/me/notifications/{notificationId}","title":"Dismiss a notification","href":"/reference/dismissSelfNotification"},{"openapi":"openapi.json GET /users/me/notifications","title":"List your notifications","href":"/reference/listSelfNotifications"},{"openapi":"openapi.json GET /users/me/notifications/unread-count","title":"Count your unread notifications","href":"/reference/countSelfUnreadNotifications"},{"openapi":"openapi.json POST /users/me/notifications/read-all","title":"Mark your notifications as read","href":"/reference/markSelfNotificationsRead"},{"openapi":"openapi.json POST /users/me/notifications/{notificationId}/read","title":"Mark one notification as read","href":"/reference/markSelfNotificationRead"}]},{"group":"MCP tokens","pages":[{"openapi":"openapi.json DELETE /users/me/mcp-tokens/{keyId}","title":"Revoke a personal MCP token","href":"/reference/revokeSelfMcpToken"},{"openapi":"openapi.json GET /users/me/mcp-tokens","title":"List your MCP token metadata","href":"/reference/listSelfMcpTokens"},{"openapi":"openapi.json POST /users/me/mcp-tokens","deprecated":true,"title":"Retired: Create a personal MCP token","href":"/reference/createSelfMcpToken"}]}]},{"group":"Account approvals","expanded":false,"pages":[{"openapi":"openapi.json POST /users/me/account-approvals","title":"Prepare an account approval","href":"/reference/prepareAccountApproval"},{"openapi":"openapi.json GET /users/me/account-approvals/{id}","title":"Read an account approval","href":"/reference/getAccountApproval"},{"openapi":"openapi.json DELETE /users/me/account-approvals/{id}","title":"Cancel a pending account approval","href":"/reference/cancelAccountApproval"},{"openapi":"openapi.json POST /users/me/account-approvals/{id}/reconcile","title":"Reconcile managed identity provisioning evidence","href":"/reference/reconcileAccountApproval"},{"group":"Account invitations","pages":[{"openapi":"openapi.json GET /users/me/account-invitations/{id}","title":"Read an account invitation","href":"/reference/getAccountInvitation"},{"openapi":"openapi.json DELETE /users/me/account-invitations/{id}","title":"Revoke an account invitation","href":"/reference/revokeAccountInvitation"},{"openapi":"openapi.json POST /users/me/account-invitations/{id}/resend","title":"Resend an account invitation","href":"/reference/resendAccountInvitation"}]}]},{"group":"API keys","expanded":false,"pages":[{"openapi":"openapi.json DELETE /api-keys/{keyId}","title":"Revoke an API credential","href":"/reference/revokeApiCredential"},{"openapi":"openapi.json GET /api-keys","title":"List API credential metadata","href":"/reference/listApiCredentials"},{"openapi":"openapi.json POST /api-keys/emergency-revoke","title":"Revoke legacy team API and MCP credentials","href":"/reference/emergencyRevokeApiCredentials"},{"openapi":"openapi.json POST /api-keys","deprecated":true,"title":"Retired: Create live and test API credentials","href":"/reference/createApiCredentials"},{"openapi":"openapi.json POST /api-keys/rotate","deprecated":true,"title":"Retired: Rotate live and test API credentials","href":"/reference/rotateApiCredentials"},{"group":"Scoped API keys","pages":[{"openapi":"openapi.json GET /users/me/scoped-api-keys/{keyId}","title":"Read exact safe key scope and permissions","href":"/reference/getScopedApiKey"},{"openapi":"openapi.json GET /users/me/scoped-api-keys/emergency-revocations/{operationId}","title":"Read saved owner scoped-key emergency status","href":"/reference/getScopedApiKeyEmergencyRevocation"},{"openapi":"openapi.json DELETE /users/me/scoped-api-keys/{keyId}","title":"Revoke only one authorized key with a persisted operation UUID","href":"/reference/revokeScopedApiKey"},{"openapi":"openapi.json GET /users/me/scoped-api-keys","title":"List named and legacy key metadata","href":"/reference/listScopedApiKeys"},{"openapi":"openapi.json GET /users/me/scoped-api-keys/policy","title":"Read eligible exact team/action/manager policy","href":"/reference/getScopedApiKeyPolicy"},{"openapi":"openapi.json GET /users/me/scoped-api-keys/{keyId}/audit","title":"Read safe per-key lifecycle audit","href":"/reference/listScopedApiKeyAudit"},{"openapi":"openapi.json POST /users/me/scoped-api-keys/emergency-revoke","title":"Revoke all billing-account scoped keys with a saved operation UUID","href":"/reference/emergencyRevokeScopedApiKeys"}]}]}]},{"group":"Account settings and integrations","pages":[{"group":"Integrations","expanded":false,"pages":[{"openapi":"openapi.json GET /teams/{id}/integrations/catalog","title":"List account integration capabilities","href":"/reference/listAccountIntegrations"},{"openapi":"openapi.json GET /teams/{id}/integrations/{provider}","title":"Read stored integration settings","href":"/reference/getAccountIntegration"},{"openapi":"openapi.json GET /teams/integrations","title":"Get stored integration status","href":"/reference/getTeamIntegrations"},{"openapi":"openapi.json PATCH /teams/{id}/integrations/{provider}/settings","title":"Update provider settings","href":"/reference/updateAccountIntegrationSettings"},{"group":"Stripe","pages":[{"openapi":"openapi.json GET /teams/{id}/integrations/stripe/connection","title":"Read Stripe connection","href":"/reference/getStripeConnectionV2"},{"openapi":"openapi.json POST /teams/{id}/integrations/stripe/connection-sessions","title":"Prepare Stripe connection","href":"/reference/prepareStripeConnectionV2"},{"openapi":"openapi.json GET /teams/{id}/integrations/stripe/operations/{operationId}","title":"Read saved Stripe operation","href":"/reference/getStripeConnectionOperationV2"},{"openapi":"openapi.json POST /teams/{id}/integrations/stripe/disconnect","title":"Remove local Stripe credentials","href":"/reference/disconnectStripeLocalV2"},{"openapi":"openapi.json POST /teams/{id}/integrations/stripe/connection-sessions/{operationId}/cancel","title":"Cancel untouched Stripe setup","href":"/reference/cancelStripeConnectionV2"},{"openapi":"openapi.json POST /teams/{id}/integrations/stripe/standard-accounts","title":"Create a Standard Stripe account","href":"/reference/createStripeStandardAccountV2"},{"openapi":"openapi.json POST /teams/{id}/integrations/stripe/standard-accounts/{accountId}/refresh","title":"Refresh Standard Stripe account activation","href":"/reference/refreshStripeStandardAccountV2"}]},{"group":"NetSuite","pages":[{"openapi":"openapi.json GET /teams/{id}/integrations/netsuite/status","title":"Get NetSuite connection status","href":"/reference/accountNetsuiteStatus"},{"openapi":"openapi.json GET /teams/{id}/integrations/netsuite/invoices/{invoiceId}/sync","title":"Get an invoice NetSuite sync status","href":"/reference/accountNetsuiteSyncStatus"},{"openapi":"openapi.json GET /teams/{id}/integrations/netsuite/syncs","title":"List NetSuite syncs","href":"/reference/accountNetsuiteSyncs"},{"openapi":"openapi.json GET /teams/{id}/integrations/netsuite/items","title":"Get NetSuite item settings","href":"/reference/accountNetsuiteItemsConfig"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/ping","title":"Test the NetSuite connection","href":"/reference/accountNetsuitePing"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/disconnect","title":"Disconnect NetSuite","href":"/reference/disconnectNetsuite"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/invoices/{invoiceId}/sync","title":"Sync an invoice to NetSuite","href":"/reference/accountNetsuiteSync"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/invoices/{invoiceId}/resync","title":"Resync an invoice to NetSuite","href":"/reference/accountNetsuiteResync"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/items/preview","title":"Preview a NetSuite item rule","href":"/reference/accountNetsuiteItemsPreview"},{"openapi":"openapi.json POST /teams/{id}/integrations/netsuite/items/rules","title":"Save a NetSuite item rule","href":"/reference/accountNetsuiteItemsRule"},{"openapi":"openapi.json DELETE /teams/{id}/integrations/netsuite/connection","deprecated":true,"title":"Disconnect NetSuite (deprecated DELETE)","href":"/reference/accountNetsuiteDisconnect"}]},{"group":"Zettle","pages":[{"openapi":"openapi.json GET /teams/{id}/integrations/zettle/status","title":"Get Zettle connection status","href":"/reference/accountZettleStatus"},{"openapi":"openapi.json PATCH /teams/{id}/integrations/zettle/connection-settings","title":"Update Zettle connection settings","href":"/reference/accountZettleSettings"},{"openapi":"openapi.json POST /teams/{id}/integrations/zettle/sync","title":"Run a Zettle sync","href":"/reference/accountZettleSync"},{"openapi":"openapi.json POST /teams/{id}/integrations/zettle/disconnect","title":"Disconnect Zettle","href":"/reference/disconnectZettle"},{"openapi":"openapi.json DELETE /teams/{id}/integrations/zettle/connection","deprecated":true,"title":"Disconnect Zettle (deprecated DELETE)","href":"/reference/accountZettleDisconnect"}]},{"group":"Airtable","pages":[{"openapi":"openapi.json POST /teams/{id}/integrations/airtable/webhooks","title":"Register an Airtable import mapping","href":"/reference/registerAirtableWebhook"},{"openapi":"openapi.json GET /teams/{id}/integrations/airtable/operations/{operationId}","title":"Read an Airtable operation","href":"/reference/getAirtableOperation"},{"openapi":"openapi.json DELETE /teams/{id}/integrations/airtable/webhooks/{webhookId}","title":"Remove an Airtable import mapping","href":"/reference/unregisterAirtableWebhook"},{"openapi":"openapi.json GET /teams/{id}/integrations/airtable/webhooks","title":"List Airtable import mappings","href":"/reference/listAirtableWebhooks"},{"openapi":"openapi.json GET /teams/{id}/integrations/airtable/bases","title":"List Airtable bases","href":"/reference/listAirtableBases"},{"openapi":"openapi.json GET /teams/{id}/integrations/airtable/bases/{baseId}/tables","title":"List Airtable tables and fields","href":"/reference/listAirtableTables"},{"openapi":"openapi.json GET /teams/{id}/integrations/airtable/bases/{baseId}/webhooks/remote","title":"Inspect remote Airtable webhooks","href":"/reference/listAirtableRemoteWebhooks"},{"openapi":"openapi.json POST /teams/{id}/integrations/airtable/disconnect","title":"Disconnect Airtable imports across modes","href":"/reference/disconnectAirtable"},{"openapi":"openapi.json POST /teams/{id}/integrations/airtable/operations/{operationId}/reconcile","title":"Reconcile Airtable without replaying writes","href":"/reference/reconcileAirtableOperation"}]}]},{"group":"Provider setup","expanded":false,"pages":[{"openapi":"openapi.json POST /teams/{id}/integration-connection-sessions","title":"Create provider browser setup session","href":"/reference/integrationSetupCreate"},{"openapi":"openapi.json GET /teams/{id}/integration-connection-sessions/{sessionId}","title":"Read provider setup outcome","href":"/reference/integrationSetupGet"},{"openapi":"openapi.json DELETE /teams/{id}/integration-connection-sessions/{sessionId}","title":"Cancel pending provider setup","href":"/reference/integrationSetupCancel"},{"openapi":"openapi.json POST /teams/{id}/integration-connection-sessions/{sessionId}/reconcile","title":"Reconcile an existing provider attempt","href":"/reference/integrationSetupReconcile"}]},{"group":"Billing","expanded":false,"pages":[{"openapi":"openapi.json GET /teams/{id}/billing/summary","title":"Read account subscription and usage","href":"/reference/accountBillingSummary"},{"openapi":"openapi.json GET /teams/{id}/billing/prices","title":"Read Pricing v3 prices","href":"/reference/accountBillingPrices"},{"openapi":"openapi.json GET /teams/{id}/billing/plans","title":"List eligible legacy account plans","href":"/reference/accountBillingPlans"},{"openapi":"openapi.json GET /teams/{id}/billing/history","title":"List account billing invoices","href":"/reference/accountBillingHistory"},{"openapi":"openapi.json GET /teams/{id}/billing/fiscal","title":"Read account fiscal details","href":"/reference/accountBillingFiscalGet"},{"openapi":"openapi.json PATCH /teams/{id}/billing/fiscal","title":"Update account fiscal details","href":"/reference/accountBillingFiscalUpdate"},{"openapi":"openapi.json POST /teams/{id}/billing/checkout","title":"Start legacy account plan checkout","href":"/reference/accountBillingCheckout"},{"openapi":"openapi.json POST /teams/{id}/billing/upgrade","title":"Upgrade legacy account subscription","href":"/reference/accountBillingUpgrade"},{"openapi":"openapi.json POST /teams/{id}/billing/portal","title":"Open account billing portal","href":"/reference/accountBillingPortal"},{"openapi":"openapi.json POST /teams/{id}/billing/go-live","title":"Take a team live (pricing v3)","href":"/reference/accountBillingGoLive"},{"openapi":"openapi.json POST /teams/{id}/billing/features","title":"Turn a feature on for a team (pricing v3)","href":"/reference/accountBillingFeatureActivate"},{"openapi":"openapi.json POST /teams/{id}/billing/features/deactivate","title":"Turn a feature off for a team (pricing v3)","href":"/reference/accountBillingFeatureDeactivate"},{"group":"Billing operations","pages":[{"openapi":"openapi.json GET /teams/{id}/billing/operations/{operationId}","title":"Read billing operation","href":"/reference/accountBillingOperationGet"},{"openapi":"openapi.json POST /teams/{id}/billing/operations/{operationId}/reconcile","title":"Reconcile billing operation","href":"/reference/accountBillingReconcile"},{"openapi":"openapi.json POST /teams/{id}/billing/operations/{operationId}/cancel","title":"Cancel an open account checkout","href":"/reference/accountBillingCheckoutCancel"},{"openapi":"openapi.json POST /teams/{id}/billing/operations/{operationId}/resolve","title":"Release uncertain billing operation","href":"/reference/accountBillingResolve"}]}]},{"group":"Pricing","expanded":false,"pages":[{"openapi":"openapi.json GET /pricing","title":"Read the public price list","href":"/reference/getPublicPrices"}]},{"group":"Branding","expanded":false,"pages":[{"openapi":"openapi.json GET /teams/{id}/customer-portal","title":"Read customer portal registration","href":"/reference/accountPortalGet"},{"openapi":"openapi.json GET /teams/{id}/brand","title":"Read team branding","href":"/reference/accountBrandGet"},{"openapi":"openapi.json PUT /teams/{id}/customer-portal","title":"Register or rename customer portal","href":"/reference/accountPortalSet"},{"openapi":"openapi.json PATCH /teams/{id}/brand","title":"Update supplied team branding fields","href":"/reference/accountBrandUpdate"},{"openapi":"openapi.json POST /teams/{id}/brand/logo","title":"Upload team logo","href":"/reference/accountBrandLogoUpload"},{"openapi":"openapi.json DELETE /teams/{id}/brand/logo","title":"Remove team logo","href":"/reference/accountBrandLogoDelete"},{"openapi":"openapi.json POST /teams/{id}/brand/analyze-voice","title":"Analyze website brand voice without saving","href":"/reference/accountBrandAnalyzeVoice"}]},{"group":"Email domain","expanded":false,"pages":[{"openapi":"openapi.json GET /teams/{id}/email-domain","title":"Read custom email domain and DNS state","href":"/reference/emailDomainGet"},{"openapi":"openapi.json PUT /teams/{id}/email-domain","title":"Set custom email domain","href":"/reference/emailDomainSet"},{"openapi":"openapi.json DELETE /teams/{id}/email-domain","title":"Remove current custom email domain","href":"/reference/emailDomainRemove"},{"openapi":"openapi.json POST /teams/{id}/email-domain/validate","title":"Validate custom email DNS","href":"/reference/emailDomainValidate"},{"group":"Email-domain operations","pages":[{"openapi":"openapi.json GET /teams/{id}/email-domain/operations/{operationId}","title":"Read email-domain operation","href":"/reference/emailDomainOperationGet"},{"openapi":"openapi.json POST /teams/{id}/email-domain/operations/{operationId}/reconcile","title":"Reconcile email-domain operation without replay","href":"/reference/emailDomainOperationReconcile"},{"openapi":"openapi.json POST /teams/{id}/email-domain/operations/{operationId}/resolve","title":"Release unresolved email-domain operation","href":"/reference/emailDomainOperationResolve"}]}]},{"group":"Fiscal handoff","expanded":false,"pages":[{"openapi":"openapi.json POST /teams/{id}/fiscal-upload-sessions","title":"Create a secure fiscal upload session","href":"/reference/createFiscalUploadSession"},{"openapi":"openapi.json GET /teams/{id}/fiscal-upload-sessions/{sessionId}","title":"Read a fiscal upload session","href":"/reference/getFiscalUploadSession"},{"openapi":"openapi.json DELETE /teams/{id}/fiscal-upload-sessions/{sessionId}","title":"Cancel a pending fiscal upload session","href":"/reference/cancelFiscalUploadSession"},{"openapi":"openapi.json GET /teams/{id}/fiscal-status","title":"Read safe team fiscal status","href":"/reference/getTeamFiscalStatus"},{"openapi":"openapi.json POST /teams/{id}/fiscal-upload-sessions/{sessionId}/reconcile","title":"Reconcile a fiscal upload outcome","href":"/reference/reconcileFiscalUploadSession"}]}]},{"group":"Health","pages":[{"group":"Auth","expanded":false,"pages":[{"openapi":"openapi.json POST /auth/sandbox","title":"Create a test-only sandbox account for a person","href":"/reference/createAgentSandbox"},{"openapi":"openapi.json POST /auth/sandbox/claim","title":"Claim a sandbox with the emailed code","href":"/reference/claimAgentSandbox"}]}]}]}]},"basePath":"","title":"Create retention - gigstack","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}