Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished.
Use this when you were already paid (cash, bank transfer, or any payment received
outside gigstack): it records the payment as succeeded and runs its automations, such as
issuing the invoice, right away. No payment link is created and nobody is charged. To
ask a customer to pay you, use POST /payments/request
instead.
gigstack Connect: Register payments for other teams using the team parameter.
Automation Types
Control what happens automatically when registering a payment:
pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately
none: No automation, registers payment only
PPD Invoice Linking
You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field.
When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.
The referenced invoice must have payment_method='PPD' and status='valid'.
Payment Form
The payment_form field specifies the Mexican SAT payment form code:
Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc.
The payment will be marked as ‘succeeded’ immediately upon registration.
Required fields
client, currency, items (at least one), payment_form and automation_type
are required. automation_type has no default — omitting it fails validation.
Allowed values: pue_invoice, ppd_invoice_and_complement, none.
date
Optional, in Unix epoch milliseconds (13 digits). Compared against
Luxon.now().toMillis(); a future value returns 400.
transfer_data — all-or-nothing
transfer_data is optional, but when it is present all four of master, connect,
master_to and connect_to are required; omitting any one fails validation.
field
type
constraint
master
number
required, 0 ≤ master ≤ 100 (percentage retained by the master team)
connect
string
required, non-empty — RFC of the connected team
master_to
enum
required — client or connect
connect_to
enum
required — client or master
connect_custom_config
object
optional; every field inside it is optional except type, rate and withholding on each taxes[] entry
invoice_config
All nested fields are optional:
field
type
meaning
serie
string
invoice series
folio
number
invoice folio number
date
number
invoice issue date, Unix epoch milliseconds
global.year
number
fiscal year of the global (EOM) invoice, e.g. 2026
global.months
string
SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb
expiry of the self-invoicing window, Unix epoch milliseconds
Email suppression
ignore_emails: true suppresses notification emails. On this endpoint send_email is
accepted but has no effect — only ignore_emails is persisted onto the payment.
Unknown fields
Body validation runs in strict allowlist mode — any undeclared key is rejected with
400 validation_failed / unexpected_key.
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
Unknown top-level keys are rejected (400 validation_failed / unexpected_key).
team, livemode and owner are reserved and injected by the auth middleware.
client
object
required
Show child attributes
automation_type
enum<string>
required
Payment automation type:
pue_invoice: Create PUE (Pago en Una sola Exhibición) invoice immediately when payment succeeds
ppd_invoice_and_complement: Create PPD (Pago en Parcialidades o Diferido) invoice immediately, then payment complement when payment succeeds
none: No automation, register payment only
Available options:
pue_invoice,
ppd_invoice_and_complement,
none
Example:
"pue_invoice"
currency
string
required
Currency code (ISO 4217)
Example:
"MXN"
items
object[]
required
Minimum array length: 1
Show child attributes
payment_form
enum<string>
required
Mexican SAT payment form code:
01: Cash
02: Check
03: Electronic transfer
04: Credit card
05: Electronic money
06: Digital money
08: Gift voucher
12: Credit for unregistered bills
13: Payment by subrogation
14: Payment by consignment
15: Condonation
17: Compensation
23: Novation
24: Confusion
25: Remission of debt
26: Prescription or expiration
27: To creditor's satisfaction
28: Credit card
29: Debit card
30: Service card
31: Applicable only to the complementary concept of donations
99: To be defined
Available options:
01,
02,
03,
04,
05,
06,
08,
12,
13,
14,
15,
17,
23,
24,
25,
26,
27,
28,
29,
30,
31,
99
Example:
"03"
exchange_rate
number | null
Exchange rate for currency conversion. If not provided, the rate from the payment date (or current date if no date specified) will be fetched automatically from our rates collection.
Example:
1
idempotency_key
string | null
Stable key for one business event. A duplicate returns HTTP 400 with error.code resource_conflict, not the existing payment as a successful response. Reconcile the existing record and retain this key; do not create a new key for a retry. Required on every item of POST /payments/register/batch.
Example:
"payment-register-12345"
metadata
object | null
Additional metadata to store with the payment
invoice_config
object | null
Optional invoice configuration. Every field is optional. Controls the folio/serie the
generated invoice will use, its issue date, the global (EOM) period it belongs to, and
how long the self-invoicing window stays open.
Show child attributes
date
number | null
Unix epoch timestamp in milliseconds (13 digits) for when the payment was received. Must be in the past. Defaults to now.
Example:
1767225600000
send_email
boolean | null
Accepted for compatibility, but on this endpoint it has no effect — only
ignore_emails is persisted onto the payment. Use ignore_emails to suppress mail.
Example:
true
ignore_emails
boolean | null
Suppress email and WhatsApp notifications for this payment and any documents
it automates (invoices, receipts). Defaults to false.
Example:
false
ppd_invoice_id
string | null
UUID of an existing PPD invoice to link this payment to. When provided, a payment complement (complemento de pago) will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method='PPD', status='valid' and invoice_type='I' — a payment complement only ever settles an income CFDI, never an egress one.
Example:
"invoice_ppd_1234567890"
invoice_exchange_rate
number | null
Optional, with ppd_invoice_id. The exchange rate your bank applied to the invoice's
currency, in MXN per unit of the invoice currency (e.g. 18.20 MXN per USD). Use it when
the PPD invoice is in a foreign currency and the payment is in another one, typically a USD
invoice paid in MXN. The payment complement then uses this rate instead of the published one
to convert the payment to the invoice currency (EquivalenciaDR = 1 / invoice_exchange_rate
for an MXN payment), and the outstanding-balance check uses it too.
Refused (400) when there is no ppd_invoice_id, when the invoice is in MXN or in the
payment's currency (use exchange_rate for the payment's own rate), for teams that do not
invoice in MXN, and when it is more than 25 % away from the published rate of the payment
date (an inverted rate or a misplaced decimal point). In a Sheets import, leave the mapped
column empty on rows that do not meet these conditions.
Example:
18.2
transfer_data
object | null
Configuration for splitting payments between master and connect teams in a marketplace.
Only available for master teams with marketplace-enabled billing accounts.
All-or-nothing: the object itself is optional, but when it is present
master, connect, master_to and connect_to are all required.
Sending transfer_data with any of them missing fails validation with
400 validation_failed. connect_custom_config stays optional.
Show child attributes
Response
Payment registered successfully. Both the standard path and the
transfer_data split path return 201 with the standardized success envelope.
Standardized success envelope emitted by sendSuccessResponse.
success
enum<boolean>
required
Available options:
true
Example:
true
data
object
required
The operation payload.
Option 1
Option 2
Show child attributes
timestamp
integer<int64>
required
Server time in epoch milliseconds (Luxon.now().toMillis()).
Example:
1767225600000
message
string
Payment registered successfully on the standard path, Split payments registered successfully on the split path.
Example:
"Payment registered 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":[],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"reference/createPaymentsRegister","slug":"/reference/createPaymentsRegister","pageMetadata":{"openapi":"openapi.json POST /payments/register","title":"Register payment (you were already paid)","description":"[Small working example](/recipes/payment)\n\n**Integration note:** Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished.\n\nUse this when **you were already paid** (cash, bank transfer, or any payment received\noutside gigstack): it records the payment as `succeeded` and runs its automations, such as\nissuing the invoice, right away. No payment link is created and nobody is charged. To\n**ask a customer to pay you**, use [`POST /payments/request`](/reference/createPaymentsRequest)\ninstead.\n\n**gigstack Connect:** Register payments for other teams using the `team` parameter.\n\n## Automation Types\n\nControl what happens automatically when registering a payment:\n\n- **`pue_invoice`**: Creates a PUE (Pago en Una sola Exhibición) invoice immediately\n- **`none`**: No automation, registers payment only\n\n## PPD Invoice Linking\n\nYou can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the `ppd_invoice_id` field.\nWhen set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.\nThe referenced invoice must have `payment_method='PPD'` and `status='valid'`.\n\n## Payment Form\n\nThe `payment_form` field specifies the Mexican SAT payment form code:\n\nCommon codes include: `01` (cash), `02` (check), `03` (electronic transfer), `04` (credit card), etc.\n\nThe payment will be marked as 'succeeded' immediately upon registration.\n\n## Required fields\n\n`client`, `currency`, `items` (at least one), `payment_form` and **`automation_type`**\nare required. `automation_type` has no default — omitting it fails validation.\nAllowed values: `pue_invoice`, `ppd_invoice_and_complement`, `none`.\n\n## `date`\n\nOptional, in **Unix epoch milliseconds** (13 digits). Compared against\n`Luxon.now().toMillis()`; a future value returns `400`.\n\n## `transfer_data` — all-or-nothing\n\n`transfer_data` is optional, but **when it is present all four of `master`, `connect`,\n`master_to` and `connect_to` are required**; omitting any one fails validation.\n\n| field | type | constraint |\n|---|---|---|\n| `master` | number | required, `0 ≤ master ≤ 100` (percentage retained by the master team) |\n| `connect` | string | required, non-empty — RFC of the connected team |\n| `master_to` | enum | required — `client` or `connect` |\n| `connect_to` | enum | required — `client` or `master` |\n| `connect_custom_config` | object | optional; every field inside it is optional except `type`, `rate` and `withholding` on each `taxes[]` entry |\n\n## `invoice_config`\n\nAll nested fields are optional:\n\n| field | type | meaning |\n|---|---|---|\n| `serie` | string | invoice series |\n| `folio` | number | invoice folio number |\n| `date` | number | invoice issue date, Unix epoch **milliseconds** |\n| `global.year` | number | fiscal year of the global (EOM) invoice, e.g. `2026` |\n| `global.months` | string | SAT `c_Meses` code, e.g. `01` for January or `13` for Jan–Feb |\n| `global.periodicity` | string | SAT `c_Periodicidad` code — `01` daily, `02` weekly, `03` fortnightly, `04` monthly, `05` bimonthly |\n| `validUntil` | number | expiry of the self-invoicing window, Unix epoch **milliseconds** |\n\n## Email suppression\n\n`ignore_emails: true` suppresses notification emails. On this endpoint `send_email` is\naccepted but has no effect — only `ignore_emails` is persisted onto the payment.\n\n## Unknown fields\n\nBody validation runs in strict allowlist mode — any undeclared key is rejected with\n`400 validation_failed` / `unexpected_key`.\n","href":"/reference/createPaymentsRegister"},"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 a: \"a\",\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: _jsx(_components.a, {\n href: \"/recipes/payment\",\n children: \"Small working example\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Integration note:\"\n }), \" Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Use this when \", _jsx(_components.strong, {\n children: \"you were already paid\"\n }), \" (cash, bank transfer, or any payment received\\noutside gigstack): it records the payment as \", _jsx(_components.code, {\n children: \"succeeded\"\n }), \" and runs its automations, such as\\nissuing the invoice, right away. No payment link is created and nobody is charged. To\\n\", _jsx(_components.strong, {\n children: \"ask a customer to pay you\"\n }), \", use \", _jsx(_components.a, {\n href: \"/reference/createPaymentsRequest\",\n children: _jsx(_components.code, {\n children: \"POST /payments/request\"\n })\n }), \"\\ninstead.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"gigstack Connect:\"\n }), \" Register payments for other teams using the \", _jsx(_components.code, {\n children: \"team\"\n }), \" parameter.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Automation Types\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Control what happens automatically when registering a payment:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"pue_invoice\"\n })\n }), \": Creates a PUE (Pago en Una sola Exhibición) invoice immediately\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"none\"\n })\n }), \": No automation, registers payment only\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"PPD Invoice Linking\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the \", _jsx(_components.code, {\n children: \"ppd_invoice_id\"\n }), \" field.\\nWhen set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.\\nThe referenced invoice must have \", _jsx(_components.code, {\n children: \"payment_method='PPD'\"\n }), \" and \", _jsx(_components.code, {\n children: \"status='valid'\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Payment Form\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"payment_form\"\n }), \" field specifies the Mexican SAT payment form code:\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Common codes include: \", _jsx(_components.code, {\n children: \"01\"\n }), \" (cash), \", _jsx(_components.code, {\n children: \"02\"\n }), \" (check), \", _jsx(_components.code, {\n children: \"03\"\n }), \" (electronic transfer), \", _jsx(_components.code, {\n children: \"04\"\n }), \" (credit card), etc.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The payment will be marked as ‘succeeded’ immediately upon registration.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Required fields\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"client\"\n }), \", \", _jsx(_components.code, {\n children: \"currency\"\n }), \", \", _jsx(_components.code, {\n children: \"items\"\n }), \" (at least one), \", _jsx(_components.code, {\n children: \"payment_form\"\n }), \" and \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"automation_type\"\n })\n }), \"\\nare required. \", _jsx(_components.code, {\n children: \"automation_type\"\n }), \" has no default — omitting it fails validation.\\nAllowed values: \", _jsx(_components.code, {\n children: \"pue_invoice\"\n }), \", \", _jsx(_components.code, {\n children: \"ppd_invoice_and_complement\"\n }), \", \", _jsx(_components.code, {\n children: \"none\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: _jsx(_components.code, {\n children: \"date\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Optional, in \", _jsx(_components.strong, {\n children: \"Unix epoch milliseconds\"\n }), \" (13 digits). Compared against\\n\", _jsx(_components.code, {\n children: \"Luxon.now().toMillis()\"\n }), \"; a future value returns \", _jsx(_components.code, {\n children: \"400\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.h2, {\n children: [_jsx(_components.code, {\n children: \"transfer_data\"\n }), \" — all-or-nothing\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"transfer_data\"\n }), \" is optional, but \", _jsxs(_components.strong, {\n children: [\"when it is present all four of \", _jsx(_components.code, {\n children: \"master\"\n }), \", \", _jsx(_components.code, {\n children: \"connect\"\n }), \",\\n\", _jsx(_components.code, {\n children: \"master_to\"\n }), \" and \", _jsx(_components.code, {\n children: \"connect_to\"\n }), \" are required\"]\n }), \"; omitting any one fails validation.\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"field\"\n }), _jsx(_components.th, {\n children: \"type\"\n }), _jsx(_components.th, {\n children: \"constraint\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"master\"\n })\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsxs(_components.td, {\n children: [\"required, \", _jsx(_components.code, {\n children: \"0 ≤ master ≤ 100\"\n }), \" (percentage retained by the master team)\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"connect\"\n })\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"required, non-empty — RFC of the connected team\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"master_to\"\n })\n }), _jsx(_components.td, {\n children: \"enum\"\n }), _jsxs(_components.td, {\n children: [\"required — \", _jsx(_components.code, {\n children: \"client\"\n }), \" or \", _jsx(_components.code, {\n children: \"connect\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"connect_to\"\n })\n }), _jsx(_components.td, {\n children: \"enum\"\n }), _jsxs(_components.td, {\n children: [\"required — \", _jsx(_components.code, {\n children: \"client\"\n }), \" or \", _jsx(_components.code, {\n children: \"master\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"connect_custom_config\"\n })\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsxs(_components.td, {\n children: [\"optional; every field inside it is optional except \", _jsx(_components.code, {\n children: \"type\"\n }), \", \", _jsx(_components.code, {\n children: \"rate\"\n }), \" and \", _jsx(_components.code, {\n children: \"withholding\"\n }), \" on each \", _jsx(_components.code, {\n children: \"taxes[]\"\n }), \" entry\"]\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h2, {\n children: _jsx(_components.code, {\n children: \"invoice_config\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"All nested fields are optional:\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"field\"\n }), _jsx(_components.th, {\n children: \"type\"\n }), _jsx(_components.th, {\n children: \"meaning\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"serie\"\n })\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"invoice series\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"folio\"\n })\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsx(_components.td, {\n children: \"invoice folio number\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"date\"\n })\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsxs(_components.td, {\n children: [\"invoice issue date, Unix epoch \", _jsx(_components.strong, {\n children: \"milliseconds\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"global.year\"\n })\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsxs(_components.td, {\n children: [\"fiscal year of the global (EOM) invoice, e.g. \", _jsx(_components.code, {\n children: \"2026\"\n })]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"global.months\"\n })\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsxs(_components.td, {\n children: [\"SAT \", _jsx(_components.code, {\n children: \"c_Meses\"\n }), \" code, e.g. \", _jsx(_components.code, {\n children: \"01\"\n }), \" for January or \", _jsx(_components.code, {\n children: \"13\"\n }), \" for Jan–Feb\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"global.periodicity\"\n })\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsxs(_components.td, {\n children: [\"SAT \", _jsx(_components.code, {\n children: \"c_Periodicidad\"\n }), \" code — \", _jsx(_components.code, {\n children: \"01\"\n }), \" daily, \", _jsx(_components.code, {\n children: \"02\"\n }), \" weekly, \", _jsx(_components.code, {\n children: \"03\"\n }), \" fortnightly, \", _jsx(_components.code, {\n children: \"04\"\n }), \" monthly, \", _jsx(_components.code, {\n children: \"05\"\n }), \" bimonthly\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"validUntil\"\n })\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsxs(_components.td, {\n children: [\"expiry of the self-invoicing window, Unix epoch \", _jsx(_components.strong, {\n children: \"milliseconds\"\n })]\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Email suppression\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"ignore_emails: true\"\n }), \" suppresses notification emails. On this endpoint \", _jsx(_components.code, {\n children: \"send_email\"\n }), \" is\\naccepted but has no effect — only \", _jsx(_components.code, {\n children: \"ignore_emails\"\n }), \" is persisted onto the payment.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Unknown fields\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Body validation runs in strict allowlist mode — any undeclared key is rejected with\\n\", _jsx(_components.code, {\n children: \"400 validation_failed\"\n }), \" / \", _jsx(_components.code, {\n children: \"unexpected_key\"\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 /payments/register","title":"Register payment (you were already paid)","description":"[Small working example](/recipes/payment)\n\n**Integration note:** Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished.\n\nUse this when **you were already paid** (cash, bank transfer, or any payment received\noutside gigstack): it records the payment as `succeeded` and runs its automations, such as\nissuing the invoice, right away. No payment link is created and nobody is charged. To\n**ask a customer to pay you**, use [`POST /payments/request`](/reference/createPaymentsRequest)\ninstead.\n\n**gigstack Connect:** Register payments for other teams using the `team` parameter.\n\n## Automation Types\n\nControl what happens automatically when registering a payment:\n\n- **`pue_invoice`**: Creates a PUE (Pago en Una sola Exhibición) invoice immediately\n- **`none`**: No automation, registers payment only\n\n## PPD Invoice Linking\n\nYou can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the `ppd_invoice_id` field.\nWhen set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.\nThe referenced invoice must have `payment_method='PPD'` and `status='valid'`.\n\n## Payment Form\n\nThe `payment_form` field specifies the Mexican SAT payment form code:\n\nCommon codes include: `01` (cash), `02` (check), `03` (electronic transfer), `04` (credit card), etc.\n\nThe payment will be marked as 'succeeded' immediately upon registration.\n\n## Required fields\n\n`client`, `currency`, `items` (at least one), `payment_form` and **`automation_type`**\nare required. `automation_type` has no default — omitting it fails validation.\nAllowed values: `pue_invoice`, `ppd_invoice_and_complement`, `none`.\n\n## `date`\n\nOptional, in **Unix epoch milliseconds** (13 digits). Compared against\n`Luxon.now().toMillis()`; a future value returns `400`.\n\n## `transfer_data` — all-or-nothing\n\n`transfer_data` is optional, but **when it is present all four of `master`, `connect`,\n`master_to` and `connect_to` are required**; omitting any one fails validation.\n\n| field | type | constraint |\n|---|---|---|\n| `master` | number | required, `0 ≤ master ≤ 100` (percentage retained by the master team) |\n| `connect` | string | required, non-empty — RFC of the connected team |\n| `master_to` | enum | required — `client` or `connect` |\n| `connect_to` | enum | required — `client` or `master` |\n| `connect_custom_config` | object | optional; every field inside it is optional except `type`, `rate` and `withholding` on each `taxes[]` entry |\n\n## `invoice_config`\n\nAll nested fields are optional:\n\n| field | type | meaning |\n|---|---|---|\n| `serie` | string | invoice series |\n| `folio` | number | invoice folio number |\n| `date` | number | invoice issue date, Unix epoch **milliseconds** |\n| `global.year` | number | fiscal year of the global (EOM) invoice, e.g. `2026` |\n| `global.months` | string | SAT `c_Meses` code, e.g. `01` for January or `13` for Jan–Feb |\n| `global.periodicity` | string | SAT `c_Periodicidad` code — `01` daily, `02` weekly, `03` fortnightly, `04` monthly, `05` bimonthly |\n| `validUntil` | number | expiry of the self-invoicing window, Unix epoch **milliseconds** |\n\n## Email suppression\n\n`ignore_emails: true` suppresses notification emails. On this endpoint `send_email` is\naccepted but has no effect — only `ignore_emails` is persisted onto the payment.\n\n## Unknown fields\n\nBody validation runs in strict allowlist mode — any undeclared key is rejected with\n`400 validation_failed` / `unexpected_key`.\n","href":"/reference/createPaymentsRegister"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createPaymentsRegister","tags":["Payments"],"summary":"Register payment (you were already paid)","description":"[Small working example](/recipes/payment)\n\n**Integration note:** Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished.\n\nUse this when **you were already paid** (cash, bank transfer, or any payment received\noutside gigstack): it records the payment as `succeeded` and runs its automations, such as\nissuing the invoice, right away. No payment link is created and nobody is charged. To\n**ask a customer to pay you**, use [`POST /payments/request`](/reference/createPaymentsRequest)\ninstead.\n\n**gigstack Connect:** Register payments for other teams using the `team` parameter.\n\n## Automation Types\n\nControl what happens automatically when registering a payment:\n\n- **`pue_invoice`**: Creates a PUE (Pago en Una sola Exhibición) invoice immediately\n- **`none`**: No automation, registers payment only\n\n## PPD Invoice Linking\n\nYou can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the `ppd_invoice_id` field.\nWhen set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice.\nThe referenced invoice must have `payment_method='PPD'` and `status='valid'`.\n\n## Payment Form\n\nThe `payment_form` field specifies the Mexican SAT payment form code:\n\nCommon codes include: `01` (cash), `02` (check), `03` (electronic transfer), `04` (credit card), etc.\n\nThe payment will be marked as 'succeeded' immediately upon registration.\n\n## Required fields\n\n`client`, `currency`, `items` (at least one), `payment_form` and **`automation_type`**\nare required. `automation_type` has no default — omitting it fails validation.\nAllowed values: `pue_invoice`, `ppd_invoice_and_complement`, `none`.\n\n## `date`\n\nOptional, in **Unix epoch milliseconds** (13 digits). Compared against\n`Luxon.now().toMillis()`; a future value returns `400`.\n\n## `transfer_data` — all-or-nothing\n\n`transfer_data` is optional, but **when it is present all four of `master`, `connect`,\n`master_to` and `connect_to` are required**; omitting any one fails validation.\n\n| field | type | constraint |\n|---|---|---|\n| `master` | number | required, `0 ≤ master ≤ 100` (percentage retained by the master team) |\n| `connect` | string | required, non-empty — RFC of the connected team |\n| `master_to` | enum | required — `client` or `connect` |\n| `connect_to` | enum | required — `client` or `master` |\n| `connect_custom_config` | object | optional; every field inside it is optional except `type`, `rate` and `withholding` on each `taxes[]` entry |\n\n## `invoice_config`\n\nAll nested fields are optional:\n\n| field | type | meaning |\n|---|---|---|\n| `serie` | string | invoice series |\n| `folio` | number | invoice folio number |\n| `date` | number | invoice issue date, Unix epoch **milliseconds** |\n| `global.year` | number | fiscal year of the global (EOM) invoice, e.g. `2026` |\n| `global.months` | string | SAT `c_Meses` code, e.g. `01` for January or `13` for Jan–Feb |\n| `global.periodicity` | string | SAT `c_Periodicidad` code — `01` daily, `02` weekly, `03` fortnightly, `04` monthly, `05` bimonthly |\n| `validUntil` | number | expiry of the self-invoicing window, Unix epoch **milliseconds** |\n\n## Email suppression\n\n`ignore_emails: true` suppresses notification emails. On this endpoint `send_email` is\naccepted but has no effect — only `ignore_emails` is persisted onto the payment.\n\n## Unknown fields\n\nBody validation runs in strict allowlist mode — any undeclared key is rejected with\n`400 validation_failed` / `unexpected_key`.\n","security":["82eec3c6-96e9-431c-81f4-b3b48ce5f69b"],"parameters":["458bf53e-df2c-4449-ad9a-37c206187068"],"requestBody":"e30844e3-6111-4096-b44e-43dcb5c4b543","responses":{"201":"546538e8-289c-4faf-8ecf-d91e065afc0a","400":"8a30d7bf-1abc-4c2d-b470-98e73baced74","401":"6670f83f-59c2-4419-b689-dd6a5fb84c26","403":"0359804c-0a8e-460f-abc2-bdfa2d35bc73","404":"61af16a8-7761-4c27-a491-64e8e850872d","409":"ed04d438-256b-4cbe-b838-2d3a58c9928a","500":"03bf8aed-64d6-454f-a59b-3d909157b51a"},"method":"post","type":"path","servers":["aab38087-9d60-4eb4-b6c9-2a7ae8d53a00"],"path":"/payments/register","baseUrlOptions":["https://api.gigstack.io/v2"],"title":"Register payment (you were already paid)","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"458bf53e-df2c-4449-ad9a-37c206187068":{"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":{"description":"Unknown top-level keys are rejected (`400 validation_failed` / `unexpected_key`).\n`team`, `livemode` and `owner` are reserved and injected by the auth middleware.\n","type":"object","additionalProperties":false,"required":["client","automation_type","currency","items","payment_form"],"properties":{"client":{"type":"object","additionalProperties":false,"properties":{"id":{"oneOf":[{"type":"string","uniqueKey":"client.id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.id","typeLabel":"string | null"},"search":{"oneOf":[{"type":"object","additionalProperties":false,"required":["on_key","on_value"],"properties":{"on_key":{"type":"string","isRequired":true,"uniqueKey":"client.search.oneOf.0.on_key","typeLabel":"string"},"on_value":{"type":"string","isRequired":true,"uniqueKey":"client.search.oneOf.0.on_value","typeLabel":"string"},"auto_create":{"oneOf":[{"type":"boolean","uniqueKey":"client.search.oneOf.0.auto_create.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"client.search.oneOf.0.auto_create.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.search.oneOf.0.auto_create","typeLabel":"boolean | null"},"safety_check":{"oneOf":[{"type":"boolean","uniqueKey":"client.search.oneOf.0.safety_check.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"client.search.oneOf.0.safety_check.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.search.oneOf.0.safety_check","typeLabel":"boolean | null"},"update":{"oneOf":[{"type":"boolean","uniqueKey":"client.search.oneOf.0.update.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"client.search.oneOf.0.update.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.search.oneOf.0.update","typeLabel":"boolean | null"}},"uniqueKey":"client.search.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["on_key","on_value"],"properties":{"on_key":{"type":"string"},"on_value":{"type":"string"},"auto_create":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"safety_check":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"update":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"uniqueKey":"client.search.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.search","typeLabel":"object | null"},"address":{"oneOf":[{"additionalProperties":false,"properties":{"country":{"oneOf":[{"maxLength":3,"type":"string","uniqueKey":"client.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"maxLength":3,"type":"null","uniqueKey":"client.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.country","typeLabel":"string | null"},"street":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.street","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.zip","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.state","typeLabel":"string | null"},"exterior":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.exterior.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.exterior.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.exterior","typeLabel":"string | null"},"interior":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.interior.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.interior.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.interior","typeLabel":"string | null"},"municipality":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.municipality.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.municipality.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.municipality","typeLabel":"string | null"},"neighborhood":{"oneOf":[{"type":"string","uniqueKey":"client.address.oneOf.0.neighborhood.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.address.oneOf.0.neighborhood.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address.oneOf.0.neighborhood","typeLabel":"string | null"}},"type":"object","uniqueKey":"client.address.oneOf.0","typeLabel":"object"},{"additionalProperties":false,"properties":{"country":{"oneOf":[{"maxLength":3,"type":"string"},{"maxLength":3,"type":"null"}]},"street":{"oneOf":[{"type":"string"},{"type":"null"}]},"zip":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"oneOf":[{"type":"string"},{"type":"null"}]},"exterior":{"oneOf":[{"type":"string"},{"type":"null"}]},"interior":{"oneOf":[{"type":"string"},{"type":"null"}]},"municipality":{"oneOf":[{"type":"string"},{"type":"null"}]},"neighborhood":{"oneOf":[{"type":"string"},{"type":"null"}]}},"type":"null","uniqueKey":"client.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.address","typeLabel":"object | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"client.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","uniqueKey":"client.company.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"client.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.phone","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"client.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.email","typeLabel":"string | null"},"bcc":{"type":"array","items":{"type":"string","uniqueKey":"client.bcc.items.[INDEX]","typeLabel":"string"},"uniqueKey":"client.bcc","typeLabel":"string[]"},"metadata":{"type":"object","additionalProperties":true,"properties":{},"uniqueKey":"client.metadata","typeLabel":"object"},"legal_name":{"oneOf":[{"type":"string","uniqueKey":"client.legal_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.legal_name","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","uniqueKey":"client.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.tax_id","typeLabel":"string | null"},"use":{"oneOf":[{"type":"string","uniqueKey":"client.use.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.use.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.use","typeLabel":"string | null"},"tax_system":{"oneOf":[{"type":"string","uniqueKey":"client.tax_system.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"client.tax_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.tax_system","typeLabel":"string | null"},"document_type":{"oneOf":[{"description":"DIAN identification document code","type":"string","enum":["","11","12","13","21","22","31","41","42","47","48","50","91",null],"uniqueKey":"client.document_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"DIAN identification document code","type":"null","enum":["","11","12","13","21","22","31","41","42","47","48","50","91",null],"uniqueKey":"client.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.document_type","typeLabel":"enum\u003cstring> | null"},"organization_type":{"oneOf":[{"type":"string","description":"1 = persona jurídica, 2 = persona natural","enum":["","1","2",null],"uniqueKey":"client.organization_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"1 = persona jurídica, 2 = persona natural","enum":["","1","2",null],"uniqueKey":"client.organization_type.oneOf.1","typeLabel":"null"},{"type":"number","description":"1 = persona jurídica, 2 = persona natural","enum":[1,2],"uniqueKey":"client.organization_type.oneOf.2","typeLabel":"enum\u003cnumber>"}],"uniqueKey":"client.organization_type","typeLabel":"enum\u003cstring> | null | enum\u003cnumber>"},"tribute_code":{"oneOf":[{"description":"'01' = responsable de IVA, 'ZZ' = no aplica","type":"string","enum":["","01","ZZ",null],"uniqueKey":"client.tribute_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"'01' = responsable de IVA, 'ZZ' = no aplica","type":"null","enum":["","01","ZZ",null],"uniqueKey":"client.tribute_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.tribute_code","typeLabel":"enum\u003cstring> | null"},"fiscal_responsibilities":{"oneOf":[{"description":"DIAN responsabilidades fiscales (lista 53). Omitted means 'R-99-PN' (no responsable)","type":"array","items":{"type":"string","enum":["O-13","O-15","O-23","O-47","R-99-PN"],"uniqueKey":"client.fiscal_responsibilities.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"client.fiscal_responsibilities.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"DIAN responsabilidades fiscales (lista 53). Omitted means 'R-99-PN' (no responsable)","type":"null","items":{"type":"string","enum":["O-13","O-15","O-23","O-47","R-99-PN"]},"uniqueKey":"client.fiscal_responsibilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.fiscal_responsibilities","typeLabel":"enum\u003cstring>[] | null"},"dv":{"oneOf":[{"description":"NIT verification digit","type":"string","pattern":"^[0-9]?$","uniqueKey":"client.dv.oneOf.0","typeLabel":"string"},{"description":"NIT verification digit","type":"null","pattern":"^[0-9]?$","uniqueKey":"client.dv.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.dv","typeLabel":"string | null"},"municipality_code":{"oneOf":[{"description":"DANE municipality code, only for clients domiciled in Colombia","type":"string","pattern":"^([0-9]{5})?$","uniqueKey":"client.municipality_code.oneOf.0","typeLabel":"string"},{"description":"DANE municipality code, only for clients domiciled in Colombia","type":"null","pattern":"^([0-9]{5})?$","uniqueKey":"client.municipality_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"client.municipality_code","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"client","typeLabel":"object"},"automation_type":{"description":"Payment automation type:\n- `pue_invoice`: Create PUE (Pago en Una sola Exhibición) invoice immediately when payment succeeds\n- `ppd_invoice_and_complement`: Create PPD (Pago en Parcialidades o Diferido) invoice immediately, then payment complement when payment succeeds\n- `none`: No automation, register payment only\n","example":"pue_invoice","type":"string","enum":["pue_invoice","ppd_invoice_and_complement","none"],"isRequired":true,"uniqueKey":"automation_type","typeLabel":"enum\u003cstring>"},"currency":{"description":"Currency code (ISO 4217)","example":"MXN","type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"items":{"type":"array","items":{"description":"A line item on an income or egress invoice, or on a payment: the same fields as `ItemSchema`, plus `note`.\nOnly `quantity` is required; everything else is optional, or resolved from the referenced\nservice when `id`/`search` is used. `id` and `search` are mutually exclusive — supplying both\nis a `400`.\n\nUnknown keys are rejected. Note there is no per-item `metadata` field.\n","type":"object","additionalProperties":false,"required":["quantity"],"properties":{"quantity":{"description":"Item quantity","example":1,"type":"number","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"},"id":{"oneOf":[{"description":"Service/product ID reference. The line inherits the service's catalog fields;\non Mexican invoices that includes its cuenta predial, stamped as the\nconcepto's `CuentaPredial` node (one per account) for arrendamiento.\n","example":"service_1234567890","type":"string","uniqueKey":"\\items.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"description":"Service/product ID reference. The line inherits the service's catalog fields;\non Mexican invoices that includes its cuenta predial, stamped as the\nconcepto's `CuentaPredial` node (one per account) for arrendamiento.\n","example":"service_1234567890","type":"null","uniqueKey":"\\items.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string | null"},"search":{"oneOf":[{"type":"object","additionalProperties":false,"required":["on_key","on_value"],"properties":{"on_key":{"description":"Field to search on (sku, name, etc.)","example":"sku","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].search.oneOf.0.on_key","typeLabel":"string"},"on_value":{"description":"Value to search for","example":"CONS-001","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].search.oneOf.0.on_value","typeLabel":"string"},"auto_create":{"oneOf":[{"description":"Create service if not found","example":true,"type":"boolean","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.auto_create.oneOf.0","typeLabel":"boolean"},{"description":"Create service if not found","example":true,"type":"null","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.auto_create.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].search.oneOf.0.auto_create","typeLabel":"boolean | null"},"safety_check":{"oneOf":[{"description":"When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false","example":false,"type":"boolean","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.safety_check.oneOf.0","typeLabel":"boolean"},{"description":"When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false","example":false,"type":"null","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.safety_check.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].search.oneOf.0.safety_check","typeLabel":"boolean | null"},"update":{"oneOf":[{"type":"boolean","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.update.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"\\items.items.[INDEX].search.oneOf.0.update.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].search.oneOf.0.update","typeLabel":"boolean | null"}},"uniqueKey":"\\items.items.[INDEX].search.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"required":["on_key","on_value"],"properties":{"on_key":{"description":"Field to search on (sku, name, etc.)","example":"sku","type":"string"},"on_value":{"description":"Value to search for","example":"CONS-001","type":"string"},"auto_create":{"oneOf":[{"description":"Create service if not found","example":true,"type":"boolean"},{"description":"Create service if not found","example":true,"type":"null"}]},"safety_check":{"oneOf":[{"description":"When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false","example":false,"type":"boolean"},{"description":"When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false","example":false,"type":"null"}]},"update":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"uniqueKey":"\\items.items.[INDEX].search.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].search","typeLabel":"object | null"},"description":{"oneOf":[{"description":"Item description","example":"Consulting services","type":"string","uniqueKey":"\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Item description","example":"Consulting services","type":"null","uniqueKey":"\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string | null"},"sku":{"oneOf":[{"description":"Stock keeping unit","example":"CONS-001","type":"string","uniqueKey":"\\items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"description":"Stock keeping unit","example":"CONS-001","type":"null","uniqueKey":"\\items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].sku","typeLabel":"string | null"},"product_key":{"oneOf":[{"description":"SAT product key (c_ClaveProdServ)","example":"80141503","type":"string","uniqueKey":"\\items.items.[INDEX].product_key.oneOf.0","typeLabel":"string"},{"description":"SAT product key (c_ClaveProdServ)","example":"80141503","type":"null","uniqueKey":"\\items.items.[INDEX].product_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].product_key","typeLabel":"string | null"},"unit_key":{"oneOf":[{"description":"SAT unit key (c_ClaveUnidad)","example":"E48","type":"string","uniqueKey":"\\items.items.[INDEX].unit_key.oneOf.0","typeLabel":"string"},{"description":"SAT unit key (c_ClaveUnidad)","example":"E48","type":"null","uniqueKey":"\\items.items.[INDEX].unit_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].unit_key","typeLabel":"string | null"},"unit_name":{"oneOf":[{"description":"Unit name","example":"Servicio","type":"string","uniqueKey":"\\items.items.[INDEX].unit_name.oneOf.0","typeLabel":"string"},{"description":"Unit name","example":"Servicio","type":"null","uniqueKey":"\\items.items.[INDEX].unit_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].unit_name","typeLabel":"string | null"},"unit_price":{"oneOf":[{"description":"Unit price","example":1000,"type":"number","uniqueKey":"\\items.items.[INDEX].unit_price.oneOf.0","typeLabel":"number"},{"description":"Unit price","example":1000,"type":"null","uniqueKey":"\\items.items.[INDEX].unit_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].unit_price","typeLabel":"number | null"},"discount":{"oneOf":[{"description":"Discount amount (absolute value in the item currency, not a percentage)","example":0,"type":"number","uniqueKey":"\\items.items.[INDEX].discount.oneOf.0","typeLabel":"number"},{"description":"Discount amount (absolute value in the item currency, not a percentage)","example":0,"type":"null","uniqueKey":"\\items.items.[INDEX].discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].discount","typeLabel":"number | null"},"taxability":{"oneOf":[{"description":"SAT `c_ObjetoImp` — whether the item is subject to tax.","example":"02","type":"string","enum":["01","02","03","04","05","06","07","08",null],"uniqueKey":"\\items.items.[INDEX].taxability.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"SAT `c_ObjetoImp` — whether the item is subject to tax.","example":"02","type":"null","enum":["01","02","03","04","05","06","07","08",null],"uniqueKey":"\\items.items.[INDEX].taxability.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxability","typeLabel":"enum\u003cstring> | null"},"taxes":{"description":"Tax elements applied to this item","type":"array","items":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.base.oneOf.0","typeLabel":"number"},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.base.oneOf.1","typeLabel":"null"},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.base.oneOf.2","typeLabel":"string"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.base","typeLabel":"number | null | string"},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.factor.oneOf.0","typeLabel":"string"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.factor.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.factor","typeLabel":"string | null"},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.inclusive.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.inclusive.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.inclusive","typeLabel":"boolean | null"},"rate":{"oneOf":[{"description":"Tax rate (e.g., 0.16 for 16% IVA)","example":0.16,"type":"number","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.rate.oneOf.0","typeLabel":"number"},{"description":"Tax rate (e.g., 0.16 for 16% IVA)","example":0.16,"type":"null","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.rate","typeLabel":"number | null"},"type":{"oneOf":[{"description":"Type of tax","example":"IVA","type":"string","enum":["IVA","ISR","IEPS",null],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of tax","example":"IVA","type":"null","enum":["IVA","ISR","IEPS",null],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.withholding.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether this is a withholding tax","uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.withholding.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0.withholding","typeLabel":"boolean | null"}},"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100}]},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"}]},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price"}]},"rate":{"oneOf":[{"description":"Tax rate (e.g., 0.16 for 16% IVA)","example":0.16,"type":"number"},{"description":"Tax rate (e.g., 0.16 for 16% IVA)","example":0.16,"type":"null"}]},"type":{"oneOf":[{"description":"Type of tax","example":"IVA","type":"string","enum":["IVA","ISR","IEPS",null]},{"description":"Type of tax","example":"IVA","type":"null","enum":["IVA","ISR","IEPS",null]}]},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax"},{"type":"null","example":false,"description":"Whether this is a withholding tax"}]}},"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].taxes.items.[INDEX]","typeLabel":"object | null"},"uniqueKey":"\\items.items.[INDEX].taxes","typeLabel":"(object | null)[]"},"third_party":{"oneOf":[{"description":"Third party information for items provided by external parties","type":"object","additionalProperties":false,"properties":{"legal_name":{"oneOf":[{"description":"Third party legal name","example":"Third Party SA","type":"string","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.legal_name.oneOf.0","typeLabel":"string"},{"description":"Third party legal name","example":"Third Party SA","type":"null","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.legal_name","typeLabel":"string | null"},"tax_id":{"oneOf":[{"description":"Third party RFC (tax ID)","example":"TPR800101ABC","type":"string","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_id.oneOf.0","typeLabel":"string"},{"description":"Third party RFC (tax ID)","example":"TPR800101ABC","type":"null","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_id","typeLabel":"string | null"},"tax_system":{"oneOf":[{"description":"Third party tax system","example":"601","type":"string","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_system.oneOf.0","typeLabel":"string"},{"description":"Third party tax system","example":"601","type":"null","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.tax_system","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"Third party ZIP code","example":"03100","type":"string","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"description":"Third party ZIP code","example":"03100","type":"null","uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0.zip","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.0","typeLabel":"object"},{"description":"Third party information for items provided by external parties","type":"null","additionalProperties":false,"properties":{"legal_name":{"oneOf":[{"description":"Third party legal name","example":"Third Party SA","type":"string"},{"description":"Third party legal name","example":"Third Party SA","type":"null"}]},"tax_id":{"oneOf":[{"description":"Third party RFC (tax ID)","example":"TPR800101ABC","type":"string"},{"description":"Third party RFC (tax ID)","example":"TPR800101ABC","type":"null"}]},"tax_system":{"oneOf":[{"description":"Third party tax system","example":"601","type":"string"},{"description":"Third party tax system","example":"601","type":"null"}]},"zip":{"oneOf":[{"description":"Third party ZIP code","example":"03100","type":"string"},{"description":"Third party ZIP code","example":"03100","type":"null"}]}},"uniqueKey":"\\items.items.[INDEX].third_party.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].third_party","typeLabel":"object | null"},"item_complement":{"oneOf":[{"description":"CFDI item-level complement.","type":"object","additionalProperties":false,"properties":{"hydrocarbons":{"oneOf":[{"description":"Complemento de hidrocarburos. All four fields are required when this object is present.","type":"object","additionalProperties":false,"required":["permit_type","permit_number","fuel_code","fuel_sub_product"],"properties":{"permit_type":{"example":"PL/12345/EXP/ES/2020","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.0.permit_type","typeLabel":"string"},"permit_number":{"example":"12345","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.0.permit_number","typeLabel":"string"},"fuel_code":{"example":"PR03","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.0.fuel_code","typeLabel":"string"},"fuel_sub_product":{"example":"10","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.0.fuel_sub_product","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.0","typeLabel":"object"},{"description":"Complemento de hidrocarburos. All four fields are required when this object is present.","type":"null","additionalProperties":false,"required":["permit_type","permit_number","fuel_code","fuel_sub_product"],"properties":{"permit_type":{"example":"PL/12345/EXP/ES/2020","type":"string"},"permit_number":{"example":"12345","type":"string"},"fuel_code":{"example":"PR03","type":"string"},"fuel_sub_product":{"example":"10","type":"string"}},"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0.hydrocarbons","typeLabel":"object | null"}},"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.0","typeLabel":"object"},{"description":"CFDI item-level complement.","type":"null","additionalProperties":false,"properties":{"hydrocarbons":{"oneOf":[{"description":"Complemento de hidrocarburos. All four fields are required when this object is present.","type":"object","additionalProperties":false,"required":["permit_type","permit_number","fuel_code","fuel_sub_product"],"properties":{"permit_type":{"example":"PL/12345/EXP/ES/2020","type":"string"},"permit_number":{"example":"12345","type":"string"},"fuel_code":{"example":"PR03","type":"string"},"fuel_sub_product":{"example":"10","type":"string"}}},{"description":"Complemento de hidrocarburos. All four fields are required when this object is present.","type":"null","additionalProperties":false,"required":["permit_type","permit_number","fuel_code","fuel_sub_product"],"properties":{"permit_type":{"example":"PL/12345/EXP/ES/2020","type":"string"},"permit_number":{"example":"12345","type":"string"},"fuel_code":{"example":"PR03","type":"string"},"fuel_sub_product":{"example":"10","type":"string"}}}]}},"uniqueKey":"\\items.items.[INDEX].item_complement.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].item_complement","typeLabel":"object | null"},"note":{"oneOf":[{"description":"**Colombia (DIAN) only.** Free text printed under this item on the PDF gigstack draws\nfor teams that use their own Colombian PDF. It is printed only: it is not sent to Factus\nand is not part of the DIAN XML. Belongs to this invoice only: it is never saved on the\nreferenced service. On a payment, it is carried to the invoice the payment stamps. Ignored in Mexico.\n","example":"Licencias para 7 colaboradores, vigencia 12 meses desde la activación","type":"string","maxLength":1000,"uniqueKey":"\\items.items.[INDEX].note.oneOf.0","typeLabel":"string"},{"description":"**Colombia (DIAN) only.** Free text printed under this item on the PDF gigstack draws\nfor teams that use their own Colombian PDF. It is printed only: it is not sent to Factus\nand is not part of the DIAN XML. Belongs to this invoice only: it is never saved on the\nreferenced service. On a payment, it is carried to the invoice the payment stamps. Ignored in Mexico.\n","example":"Licencias para 7 colaboradores, vigencia 12 meses desde la activación","type":"null","maxLength":1000,"uniqueKey":"\\items.items.[INDEX].note.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].note","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"payment_form":{"description":"Mexican SAT payment form code:\n- `01`: Cash\n- `02`: Check\n- `03`: Electronic transfer\n- `04`: Credit card\n- `05`: Electronic money\n- `06`: Digital money\n- `08`: Gift voucher\n- `12`: Credit for unregistered bills\n- `13`: Payment by subrogation\n- `14`: Payment by consignment\n- `15`: Condonation\n- `17`: Compensation\n- `23`: Novation\n- `24`: Confusion\n- `25`: Remission of debt\n- `26`: Prescription or expiration\n- `27`: To creditor's satisfaction\n- `28`: Credit card\n- `29`: Debit card\n- `30`: Service card\n- `31`: Applicable only to the complementary concept of donations\n- `99`: To be defined\n","example":"03","type":"string","enum":["01","02","03","04","05","06","08","12","13","14","15","17","23","24","25","26","27","28","29","30","31","99"],"isRequired":true,"uniqueKey":"payment_form","typeLabel":"enum\u003cstring>"},"exchange_rate":{"oneOf":[{"description":"Exchange rate for currency conversion. If not provided, the rate from the payment date (or current date if no date specified) will be fetched automatically from our rates collection.","example":1,"type":"number","uniqueKey":"exchange_rate.oneOf.0","typeLabel":"number"},{"description":"Exchange rate for currency conversion. If not provided, the rate from the payment date (or current date if no date specified) will be fetched automatically from our rates collection.","example":1,"type":"null","uniqueKey":"exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"exchange_rate","typeLabel":"number | null"},"idempotency_key":{"oneOf":[{"description":"Stable key for one business event. A duplicate returns HTTP 400 with error.code resource_conflict, not the existing payment as a successful response. Reconcile the existing record and retain this key; do not create a new key for a retry. Required on every item of `POST /payments/register/batch`.","example":"payment-register-12345","type":"string","uniqueKey":"idempotency_key.oneOf.0","typeLabel":"string"},{"description":"Stable key for one business event. A duplicate returns HTTP 400 with error.code resource_conflict, not the existing payment as a successful response. Reconcile the existing record and retain this key; do not create a new key for a retry. Required on every item of `POST /payments/register/batch`.","example":"payment-register-12345","type":"null","uniqueKey":"idempotency_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"idempotency_key","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Additional metadata to store with the payment","type":"object","additionalProperties":true,"properties":{},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"description":"Additional metadata to store with the payment","type":"null","additionalProperties":true,"properties":{},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"invoice_config":{"oneOf":[{"description":"Optional invoice configuration. Every field is optional. Controls the folio/serie the\ngenerated invoice will use, its issue date, the global (EOM) period it belongs to, and\nhow long the self-invoicing window stays open.\n","type":"object","additionalProperties":false,"properties":{"serie":{"oneOf":[{"description":"Invoice serie. Will set/create the series for the team if provided.","example":"A","type":"string","uniqueKey":"invoice_config.oneOf.0.serie.oneOf.0","typeLabel":"string"},{"description":"Invoice serie. Will set/create the series for the team if provided.","example":"A","type":"null","uniqueKey":"invoice_config.oneOf.0.serie.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.serie","typeLabel":"string | null"},"folio":{"oneOf":[{"description":"Invoice folio number. If omitted, the automatic incrementing folio is used. When provided, duplicates may occur.","example":123,"type":"number","uniqueKey":"invoice_config.oneOf.0.folio.oneOf.0","typeLabel":"number"},{"description":"Invoice folio number. If omitted, the automatic incrementing folio is used. When provided, duplicates may occur.","example":123,"type":"null","uniqueKey":"invoice_config.oneOf.0.folio.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.folio","typeLabel":"number | null"},"date":{"oneOf":[{"description":"Invoice issue date as a Unix epoch timestamp in **milliseconds**.","example":1767225600000,"type":"number","uniqueKey":"invoice_config.oneOf.0.date.oneOf.0","typeLabel":"number"},{"description":"Invoice issue date as a Unix epoch timestamp in **milliseconds**.","example":1767225600000,"type":"null","uniqueKey":"invoice_config.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.date","typeLabel":"number | null"},"global":{"oneOf":[{"description":"Period of the global (factura global / EOM) invoice this document belongs to.","type":"object","additionalProperties":false,"properties":{"year":{"type":"number","description":"Fiscal year, four digits, from 2021 (the first year SAT accepts on a global invoice) to 2100. A number or a numeric string such as \"2026\"; stored as a number.","maximum":2100,"minimum":2021,"example":2026,"uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.year","typeLabel":"number"},"months":{"oneOf":[{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"string","uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.months.oneOf.0","typeLabel":"string"},{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"null","uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.months.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.months","typeLabel":"string | null"},"periodicity":{"oneOf":[{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"string","uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.periodicity.oneOf.0","typeLabel":"string"},{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"null","uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.periodicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.global.oneOf.0.periodicity","typeLabel":"string | null"}},"uniqueKey":"invoice_config.oneOf.0.global.oneOf.0","typeLabel":"object"},{"description":"Period of the global (factura global / EOM) invoice this document belongs to.","type":"null","additionalProperties":false,"properties":{"year":{"type":"number","description":"Fiscal year, four digits, from 2021 (the first year SAT accepts on a global invoice) to 2100. A number or a numeric string such as \"2026\"; stored as a number.","maximum":2100,"minimum":2021,"example":2026},"months":{"oneOf":[{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"string"},{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"null"}]},"periodicity":{"oneOf":[{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"string"},{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"null"}]}},"uniqueKey":"invoice_config.oneOf.0.global.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.global","typeLabel":"object | null"},"validUntil":{"oneOf":[{"description":"Expiry of the self-invoicing window, Unix epoch **milliseconds**.","example":1769817600000,"type":"number","uniqueKey":"invoice_config.oneOf.0.validUntil.oneOf.0","typeLabel":"number"},{"description":"Expiry of the self-invoicing window, Unix epoch **milliseconds**.","example":1769817600000,"type":"null","uniqueKey":"invoice_config.oneOf.0.validUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config.oneOf.0.validUntil","typeLabel":"number | null"}},"uniqueKey":"invoice_config.oneOf.0","typeLabel":"object"},{"description":"Optional invoice configuration. Every field is optional. Controls the folio/serie the\ngenerated invoice will use, its issue date, the global (EOM) period it belongs to, and\nhow long the self-invoicing window stays open.\n","type":"null","additionalProperties":false,"properties":{"serie":{"oneOf":[{"description":"Invoice serie. Will set/create the series for the team if provided.","example":"A","type":"string"},{"description":"Invoice serie. Will set/create the series for the team if provided.","example":"A","type":"null"}]},"folio":{"oneOf":[{"description":"Invoice folio number. If omitted, the automatic incrementing folio is used. When provided, duplicates may occur.","example":123,"type":"number"},{"description":"Invoice folio number. If omitted, the automatic incrementing folio is used. When provided, duplicates may occur.","example":123,"type":"null"}]},"date":{"oneOf":[{"description":"Invoice issue date as a Unix epoch timestamp in **milliseconds**.","example":1767225600000,"type":"number"},{"description":"Invoice issue date as a Unix epoch timestamp in **milliseconds**.","example":1767225600000,"type":"null"}]},"global":{"oneOf":[{"description":"Period of the global (factura global / EOM) invoice this document belongs to.","type":"object","additionalProperties":false,"properties":{"year":{"type":"number","description":"Fiscal year, four digits, from 2021 (the first year SAT accepts on a global invoice) to 2100. A number or a numeric string such as \"2026\"; stored as a number.","maximum":2100,"minimum":2021,"example":2026},"months":{"oneOf":[{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"string"},{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"null"}]},"periodicity":{"oneOf":[{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"string"},{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"null"}]}}},{"description":"Period of the global (factura global / EOM) invoice this document belongs to.","type":"null","additionalProperties":false,"properties":{"year":{"type":"number","description":"Fiscal year, four digits, from 2021 (the first year SAT accepts on a global invoice) to 2100. A number or a numeric string such as \"2026\"; stored as a number.","maximum":2100,"minimum":2021,"example":2026},"months":{"oneOf":[{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"string"},{"description":"SAT `c_Meses` code. `01`–`12` for a single month; `13`–`18` for the\nbimonthly periods (`13` = Jan–Feb … `18` = Nov–Dec).\n","example":"01","type":"null"}]},"periodicity":{"oneOf":[{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"string"},{"description":"SAT `c_Periodicidad` code: `01` daily, `02` weekly, `03` fortnightly,\n`04` monthly, `05` bimonthly.\n","example":"04","type":"null"}]}}}]},"validUntil":{"oneOf":[{"description":"Expiry of the self-invoicing window, Unix epoch **milliseconds**.","example":1769817600000,"type":"number"},{"description":"Expiry of the self-invoicing window, Unix epoch **milliseconds**.","example":1769817600000,"type":"null"}]}},"uniqueKey":"invoice_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_config","typeLabel":"object | null"},"date":{"oneOf":[{"description":"Unix epoch timestamp in **milliseconds** (13 digits) for when the payment was received. Must be in the past. Defaults to now.","example":1767225600000,"type":"number","uniqueKey":"date.oneOf.0","typeLabel":"number"},{"description":"Unix epoch timestamp in **milliseconds** (13 digits) for when the payment was received. Must be in the past. Defaults to now.","example":1767225600000,"type":"null","uniqueKey":"date.oneOf.1","typeLabel":"null"}],"uniqueKey":"date","typeLabel":"number | null"},"send_email":{"oneOf":[{"description":"Accepted for compatibility, but on this endpoint it has **no effect** — only\n`ignore_emails` is persisted onto the payment. Use `ignore_emails` to suppress mail.\n","example":true,"type":"boolean","uniqueKey":"send_email.oneOf.0","typeLabel":"boolean"},{"description":"Accepted for compatibility, but on this endpoint it has **no effect** — only\n`ignore_emails` is persisted onto the payment. Use `ignore_emails` to suppress mail.\n","example":true,"type":"null","uniqueKey":"send_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"send_email","typeLabel":"boolean | null"},"ignore_emails":{"oneOf":[{"description":"Suppress email and WhatsApp notifications for this payment and any documents\nit automates (invoices, receipts). Defaults to `false`.\n","example":false,"type":"boolean","uniqueKey":"ignore_emails.oneOf.0","typeLabel":"boolean"},{"description":"Suppress email and WhatsApp notifications for this payment and any documents\nit automates (invoices, receipts). Defaults to `false`.\n","example":false,"type":"null","uniqueKey":"ignore_emails.oneOf.1","typeLabel":"null"}],"uniqueKey":"ignore_emails","typeLabel":"boolean | null"},"ppd_invoice_id":{"oneOf":[{"description":"UUID of an existing PPD invoice to link this payment to. When provided, a payment complement (complemento de pago) will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method='PPD', status='valid' and invoice_type='I' — a payment complement only ever settles an income CFDI, never an egress one.","example":"invoice_ppd_1234567890","type":"string","uniqueKey":"ppd_invoice_id.oneOf.0","typeLabel":"string"},{"description":"UUID of an existing PPD invoice to link this payment to. When provided, a payment complement (complemento de pago) will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method='PPD', status='valid' and invoice_type='I' — a payment complement only ever settles an income CFDI, never an egress one.","example":"invoice_ppd_1234567890","type":"null","uniqueKey":"ppd_invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"ppd_invoice_id","typeLabel":"string | null"},"invoice_exchange_rate":{"oneOf":[{"description":"Optional, with `ppd_invoice_id`. The exchange rate your bank applied to the invoice's\ncurrency, in MXN per unit of the invoice currency (e.g. `18.20` MXN per USD). Use it when\nthe PPD invoice is in a foreign currency and the payment is in another one, typically a USD\ninvoice paid in MXN. The payment complement then uses this rate instead of the published one\nto convert the payment to the invoice currency (`EquivalenciaDR = 1 / invoice_exchange_rate`\nfor an MXN payment), and the outstanding-balance check uses it too.\n\nRefused (400) when there is no `ppd_invoice_id`, when the invoice is in MXN or in the\npayment's currency (use `exchange_rate` for the payment's own rate), for teams that do not\ninvoice in MXN, and when it is more than 25 % away from the published rate of the payment\ndate (an inverted rate or a misplaced decimal point). In a Sheets import, leave the mapped\ncolumn empty on rows that do not meet these conditions.\n","example":18.2,"type":"number","uniqueKey":"invoice_exchange_rate.oneOf.0","typeLabel":"number"},{"description":"Optional, with `ppd_invoice_id`. The exchange rate your bank applied to the invoice's\ncurrency, in MXN per unit of the invoice currency (e.g. `18.20` MXN per USD). Use it when\nthe PPD invoice is in a foreign currency and the payment is in another one, typically a USD\ninvoice paid in MXN. The payment complement then uses this rate instead of the published one\nto convert the payment to the invoice currency (`EquivalenciaDR = 1 / invoice_exchange_rate`\nfor an MXN payment), and the outstanding-balance check uses it too.\n\nRefused (400) when there is no `ppd_invoice_id`, when the invoice is in MXN or in the\npayment's currency (use `exchange_rate` for the payment's own rate), for teams that do not\ninvoice in MXN, and when it is more than 25 % away from the published rate of the payment\ndate (an inverted rate or a misplaced decimal point). In a Sheets import, leave the mapped\ncolumn empty on rows that do not meet these conditions.\n","example":18.2,"type":"null","uniqueKey":"invoice_exchange_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_exchange_rate","typeLabel":"number | null"},"transfer_data":{"oneOf":[{"description":"Configuration for splitting payments between master and connect teams in a marketplace.\nOnly available for master teams with marketplace-enabled billing accounts.\n\n**All-or-nothing:** the object itself is optional, but when it is present\n`master`, `connect`, `master_to` and `connect_to` are **all required**.\nSending `transfer_data` with any of them missing fails validation with\n`400 validation_failed`. `connect_custom_config` stays optional.\n","type":"object","additionalProperties":false,"required":["master","connect","master_to","connect_to"],"properties":{"master":{"description":"Required when `transfer_data` is present. Percentage of the payment retained by the master team. Must be between 0 and 100 inclusive.","example":10,"type":"number","minimum":0,"maximum":100,"isRequired":true,"uniqueKey":"transfer_data.oneOf.0.master","typeLabel":"number"},"connect":{"description":"Required when `transfer_data` is present. Tax ID (RFC) or Team ID of the connect team. If not found, a new team will be created.","example":"ABC123456789","type":"string","minLength":1,"isRequired":true,"uniqueKey":"transfer_data.oneOf.0.connect","typeLabel":"string"},"master_to":{"description":"Determines which client to assign to the master payment:\n- `client`: Use the original client from the request\n- `connect`: Create the connect team as a client for the master payment\n","example":"client","type":"string","enum":["client","connect"],"isRequired":true,"uniqueKey":"transfer_data.oneOf.0.master_to","typeLabel":"enum\u003cstring>"},"connect_to":{"description":"Determines which client to assign to the connect payment:\n- `client`: Use the original client from the request\n- `master`: Create the master team as a client for the connect payment\n","example":"client","type":"string","enum":["client","master"],"isRequired":true,"uniqueKey":"transfer_data.oneOf.0.connect_to","typeLabel":"enum\u003cstring>"},"connect_custom_config":{"oneOf":[{"description":"Optional configuration to customize items in the connect payment","type":"object","additionalProperties":false,"properties":{"product_key":{"oneOf":[{"description":"SAT product key to use for connect payment items","example":"01010101","type":"string","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.product_key.oneOf.0","typeLabel":"string"},{"description":"SAT product key to use for connect payment items","example":"01010101","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.product_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.product_key","typeLabel":"string | null"},"unit_key":{"oneOf":[{"description":"SAT unit key to use for connect payment items","example":"E48","type":"string","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.unit_key.oneOf.0","typeLabel":"string"},{"description":"SAT unit key to use for connect payment items","example":"E48","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.unit_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.unit_key","typeLabel":"string | null"},"taxes":{"oneOf":[{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"array","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"],"isRequired":true,"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number","isRequired":true,"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].rate","typeLabel":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean","isRequired":true,"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].withholding","typeLabel":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].base.oneOf.0","typeLabel":"number"},{"description":"Optional tax base amount","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].base.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].base","typeLabel":"number | null"},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].factor.oneOf.0","typeLabel":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].factor.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].factor","typeLabel":"string | null"},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].inclusive.oneOf.0","typeLabel":"boolean"},{"description":"Whether tax is included in the price","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].inclusive.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX].inclusive","typeLabel":"boolean | null"}},"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.0","typeLabel":"object[]"},{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"null","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}},"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.taxes","typeLabel":"object[] | null"},"custom_description":{"oneOf":[{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"string","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_description.oneOf.0","typeLabel":"string"},{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"null","uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_description","typeLabel":"string | null"},"custom_price":{"oneOf":[{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"number","minimum":0,"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_price.oneOf.0","typeLabel":"number"},{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"null","minimum":0,"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0.custom_price","typeLabel":"number | null"}},"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.0","typeLabel":"object"},{"description":"Optional configuration to customize items in the connect payment","type":"null","additionalProperties":false,"properties":{"product_key":{"oneOf":[{"description":"SAT product key to use for connect payment items","example":"01010101","type":"string"},{"description":"SAT product key to use for connect payment items","example":"01010101","type":"null"}]},"unit_key":{"oneOf":[{"description":"SAT unit key to use for connect payment items","example":"E48","type":"string"},{"description":"SAT unit key to use for connect payment items","example":"E48","type":"null"}]},"taxes":{"oneOf":[{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"array","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}},{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"null","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}}]},"custom_description":{"oneOf":[{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"string"},{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"null"}]},"custom_price":{"oneOf":[{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"number","minimum":0},{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"null","minimum":0}]}},"uniqueKey":"transfer_data.oneOf.0.connect_custom_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data.oneOf.0.connect_custom_config","typeLabel":"object | null"}},"uniqueKey":"transfer_data.oneOf.0","typeLabel":"object"},{"description":"Configuration for splitting payments between master and connect teams in a marketplace.\nOnly available for master teams with marketplace-enabled billing accounts.\n\n**All-or-nothing:** the object itself is optional, but when it is present\n`master`, `connect`, `master_to` and `connect_to` are **all required**.\nSending `transfer_data` with any of them missing fails validation with\n`400 validation_failed`. `connect_custom_config` stays optional.\n","type":"null","additionalProperties":false,"required":["master","connect","master_to","connect_to"],"properties":{"master":{"description":"Required when `transfer_data` is present. Percentage of the payment retained by the master team. Must be between 0 and 100 inclusive.","example":10,"type":"number","minimum":0,"maximum":100},"connect":{"description":"Required when `transfer_data` is present. Tax ID (RFC) or Team ID of the connect team. If not found, a new team will be created.","example":"ABC123456789","type":"string","minLength":1},"master_to":{"description":"Determines which client to assign to the master payment:\n- `client`: Use the original client from the request\n- `connect`: Create the connect team as a client for the master payment\n","example":"client","type":"string","enum":["client","connect"]},"connect_to":{"description":"Determines which client to assign to the connect payment:\n- `client`: Use the original client from the request\n- `master`: Create the master team as a client for the connect payment\n","example":"client","type":"string","enum":["client","master"]},"connect_custom_config":{"oneOf":[{"description":"Optional configuration to customize items in the connect payment","type":"object","additionalProperties":false,"properties":{"product_key":{"oneOf":[{"description":"SAT product key to use for connect payment items","example":"01010101","type":"string"},{"description":"SAT product key to use for connect payment items","example":"01010101","type":"null"}]},"unit_key":{"oneOf":[{"description":"SAT unit key to use for connect payment items","example":"E48","type":"string"},{"description":"SAT unit key to use for connect payment items","example":"E48","type":"null"}]},"taxes":{"oneOf":[{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"array","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}},{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"null","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}}]},"custom_description":{"oneOf":[{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"string"},{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"null"}]},"custom_price":{"oneOf":[{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"number","minimum":0},{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"null","minimum":0}]}}},{"description":"Optional configuration to customize items in the connect payment","type":"null","additionalProperties":false,"properties":{"product_key":{"oneOf":[{"description":"SAT product key to use for connect payment items","example":"01010101","type":"string"},{"description":"SAT product key to use for connect payment items","example":"01010101","type":"null"}]},"unit_key":{"oneOf":[{"description":"SAT unit key to use for connect payment items","example":"E48","type":"string"},{"description":"SAT unit key to use for connect payment items","example":"E48","type":"null"}]},"taxes":{"oneOf":[{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"array","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}},{"description":"Custom tax configuration for connect payment items (uses same schema as regular item taxes)","type":"null","items":{"type":"object","additionalProperties":false,"required":["type","rate","withholding"],"properties":{"type":{"description":"Tax type","example":"IVA","type":"string","enum":["IVA","ISR","IEPS"]},"rate":{"description":"Tax rate as decimal (0.16 = 16%)","example":0.16,"type":"number"},"withholding":{"description":"true = retention (deducted from total), false = regular tax (added to subtotal)","example":false,"type":"boolean"},"base":{"oneOf":[{"description":"Optional tax base amount","type":"number"},{"description":"Optional tax base amount","type":"null"}]},"factor":{"oneOf":[{"description":"Optional tax factor","example":"Tasa","type":"string"},{"description":"Optional tax factor","example":"Tasa","type":"null"}]},"inclusive":{"oneOf":[{"description":"Whether tax is included in the price","type":"boolean"},{"description":"Whether tax is included in the price","type":"null"}]}}}}]},"custom_description":{"oneOf":[{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"string"},{"description":"Custom description for connect payment items","example":"Professional consulting services","type":"null"}]},"custom_price":{"oneOf":[{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"number","minimum":0},{"description":"Fixed amount for connect payment (overrides percentage calculation). When set, connect gets this exact amount and master gets the remainder.","example":250,"type":"null","minimum":0}]}}}]}},"uniqueKey":"transfer_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_data","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"standard_payment":{"title":"standard_payment","summary":"Standard payment without splitting","value":{"client":{"id":"client_1234567890"},"automation_type":"pue_invoice","currency":"MXN","exchange_rate":1,"payment_form":"03","items":[{"id":"service_1234567890","quantity":1,"unit_price":1000}]}},"percentage_split":{"title":"percentage_split","summary":"Payment with percentage-based splitting","value":{"client":{"id":"client_1234567890"},"automation_type":"pue_invoice","currency":"MXN","payment_form":"03","items":[{"id":"service_1234567890","quantity":1,"unit_price":1000}],"transfer_data":{"master":30,"connect":"EMP800101ABC","master_to":"client","connect_to":"master"}}},"ppd_complement":{"title":"ppd_complement","summary":"Payment linked to an existing PPD invoice","description":"Register a payment and automatically generate a payment complement (complemento de pago) linked to an existing PPD invoice","value":{"client":{"id":"client_1234567890"},"automation_type":"none","currency":"MXN","exchange_rate":1,"payment_form":"03","ppd_invoice_id":"invoice_ppd_1234567890","items":[{"id":"service_1234567890","quantity":1,"unit_price":1000}]}},"fixed_commission":{"title":"fixed_commission","summary":"Payment with fixed commission fee","description":"Use custom_price to charge a fixed commission instead of percentage","value":{"client":{"id":"client_1234567890"},"automation_type":"pue_invoice","currency":"MXN","payment_form":"03","items":[{"id":"service_1234567890","quantity":1,"unit_price":1000}],"transfer_data":{"master":0,"connect":"EMP800101ABC","master_to":"client","connect_to":"master","connect_custom_config":{"custom_price":50,"custom_description":"Platform service fee"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"546538e8-289c-4faf-8ecf-d91e065afc0a":{"description":"Payment registered successfully. **Both** the standard path and the\n`transfer_data` split path return `201` with the standardized success envelope.\n","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":{"oneOf":[{"type":"object","description":"The operation payload.","required":["id","client","currency","exchange_rate","items","team","idempotency_key","from","invoices","livemode","owner","payment_form","payments","receipts","refunds","short_url","status","total","total_refunded","subtotal","taxes","discount","withholding_taxes","created_at","succeeded_at","payment_processor"],"properties":{"id":{"type":"string","example":"payment_1234567890","description":"Unique payment identifier","isRequired":true,"uniqueKey":"data.oneOf.0.id","typeLabel":"string"},"client":{"type":"object","required":["id","email","from","livemode","owner","team","created_at"],"properties":{"id":{"type":"string","example":"client_1234567890","description":"Unique client identifier","isRequired":true,"uniqueKey":"data.oneOf.0.client.id","typeLabel":"string"},"email":{"oneOf":[{"type":"string","format":"email","example":"juan.perez@ejemplo.com","description":"Client email address","isRequired":true,"uniqueKey":"data.oneOf.0.client.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","example":"juan.perez@ejemplo.com","description":"Client email address","isRequired":true,"uniqueKey":"data.oneOf.0.client.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.client.email","typeLabel":"string\u003cemail> | null"},"from":{"type":"string","example":"api","description":"Source of client creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","isRequired":true,"uniqueKey":"data.oneOf.0.client.from","typeLabel":"string"},"livemode":{"type":"boolean","example":true,"description":"Whether this client is in live mode","isRequired":true,"uniqueKey":"data.oneOf.0.client.livemode","typeLabel":"boolean"},"owner":{"type":"string","example":"user_1234567890","description":"User ID who owns this client","isRequired":true,"uniqueKey":"data.oneOf.0.client.owner","typeLabel":"string"},"team":{"type":"string","example":"team_1234567890","description":"Team ID this client belongs to","isRequired":true,"uniqueKey":"data.oneOf.0.client.team","typeLabel":"string"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of client creation","isRequired":true,"uniqueKey":"data.oneOf.0.client.created_at","typeLabel":"number"},"address":{"type":"object","additionalProperties":false,"properties":{"country":{"oneOf":[{"example":"MEX","type":"string","maxLength":3,"uniqueKey":"data.oneOf.0.client.address.country.oneOf.0","typeLabel":"string"},{"example":"MEX","type":"null","maxLength":3,"uniqueKey":"data.oneOf.0.client.address.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.country","typeLabel":"string | null"},"street":{"oneOf":[{"example":"Av. Insurgentes Sur","type":"string","uniqueKey":"data.oneOf.0.client.address.street.oneOf.0","typeLabel":"string"},{"example":"Av. Insurgentes Sur","type":"null","uniqueKey":"data.oneOf.0.client.address.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.street","typeLabel":"string | null"},"zip":{"oneOf":[{"example":"03100","type":"string","uniqueKey":"data.oneOf.0.client.address.zip.oneOf.0","typeLabel":"string"},{"example":"03100","type":"null","uniqueKey":"data.oneOf.0.client.address.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.zip","typeLabel":"string | null"},"city":{"oneOf":[{"example":"Ciudad de México","type":"string","uniqueKey":"data.oneOf.0.client.address.city.oneOf.0","typeLabel":"string"},{"example":"Ciudad de México","type":"null","uniqueKey":"data.oneOf.0.client.address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.city","typeLabel":"string | null"},"state":{"oneOf":[{"example":"CDMX","type":"string","uniqueKey":"data.oneOf.0.client.address.state.oneOf.0","typeLabel":"string"},{"example":"CDMX","type":"null","uniqueKey":"data.oneOf.0.client.address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.state","typeLabel":"string | null"},"exterior":{"oneOf":[{"example":"123","type":"string","uniqueKey":"data.oneOf.0.client.address.exterior.oneOf.0","typeLabel":"string"},{"example":"123","type":"null","uniqueKey":"data.oneOf.0.client.address.exterior.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.exterior","typeLabel":"string | null"},"interior":{"oneOf":[{"example":"4B","type":"string","uniqueKey":"data.oneOf.0.client.address.interior.oneOf.0","typeLabel":"string"},{"example":"4B","type":"null","uniqueKey":"data.oneOf.0.client.address.interior.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.interior","typeLabel":"string | null"},"municipality":{"oneOf":[{"example":"Benito Juárez","type":"string","uniqueKey":"data.oneOf.0.client.address.municipality.oneOf.0","typeLabel":"string"},{"example":"Benito Juárez","type":"null","uniqueKey":"data.oneOf.0.client.address.municipality.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.municipality","typeLabel":"string | null"},"neighborhood":{"oneOf":[{"example":"Del Valle","type":"string","uniqueKey":"data.oneOf.0.client.address.neighborhood.oneOf.0","typeLabel":"string"},{"example":"Del Valle","type":"null","uniqueKey":"data.oneOf.0.client.address.neighborhood.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.address.neighborhood","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.client.address","typeLabel":"object"},"name":{"oneOf":[{"type":"string","example":"Juan Pérez García","description":"Client name","uniqueKey":"data.oneOf.0.client.name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Juan Pérez García","description":"Client name","uniqueKey":"data.oneOf.0.client.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","example":"Empresa SA de CV","description":"Client company name","uniqueKey":"data.oneOf.0.client.company.oneOf.0","typeLabel":"string"},{"type":"null","example":"Empresa SA de CV","description":"Client company name","uniqueKey":"data.oneOf.0.client.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","example":"+52 55 1234 5678","description":"Client phone number","uniqueKey":"data.oneOf.0.client.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"+52 55 1234 5678","description":"Client phone number","uniqueKey":"data.oneOf.0.client.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.phone","typeLabel":"string | null"},"bcc":{"oneOf":[{"type":"array","items":{"type":"string","format":"email","uniqueKey":"data.oneOf.0.client.bcc.oneOf.0.items.[INDEX]","typeLabel":"string\u003cemail>"},"example":["admin@empresa.com"],"description":"BCC email addresses for client communications","uniqueKey":"data.oneOf.0.client.bcc.oneOf.0","typeLabel":"string\u003cemail>[]"},{"type":"null","items":{"type":"string","format":"email"},"example":["admin@empresa.com"],"description":"BCC email addresses for client communications","uniqueKey":"data.oneOf.0.client.bcc.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.bcc","typeLabel":"string\u003cemail>[] | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"example":{"custom_field":"value"},"description":"Additional metadata for the client","uniqueKey":"data.oneOf.0.client.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"example":{"custom_field":"value"},"description":"Additional metadata for the client","uniqueKey":"data.oneOf.0.client.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.metadata","typeLabel":"object | null"},"is_valid":{"oneOf":[{"type":"boolean","example":true,"description":"Whether the client data is valid","uniqueKey":"data.oneOf.0.client.is_valid.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"description":"Whether the client data is valid","uniqueKey":"data.oneOf.0.client.is_valid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.is_valid","typeLabel":"boolean | null"},"legal_name":{"oneOf":[{"type":"string","example":"Juan Pérez García","description":"Legal name for tax purposes","uniqueKey":"data.oneOf.0.client.legal_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Juan Pérez García","description":"Legal name for tax purposes","uniqueKey":"data.oneOf.0.client.legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.legal_name","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","example":"PEGJ800101ABC","description":"RFC (Tax ID) for Mexican tax compliance","uniqueKey":"data.oneOf.0.client.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"PEGJ800101ABC","description":"RFC (Tax ID) for Mexican tax compliance","uniqueKey":"data.oneOf.0.client.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.tax_id","typeLabel":"string | null"},"use":{"oneOf":[{"type":"string","example":"G03","description":"CFDI use code","uniqueKey":"data.oneOf.0.client.use.oneOf.0","typeLabel":"string"},{"type":"null","example":"G03","description":"CFDI use code","uniqueKey":"data.oneOf.0.client.use.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.use","typeLabel":"string | null"},"tax_system":{"oneOf":[{"type":"string","example":"601","description":"SAT tax system code","uniqueKey":"data.oneOf.0.client.tax_system.oneOf.0","typeLabel":"string"},{"type":"null","example":"601","description":"SAT tax system code","uniqueKey":"data.oneOf.0.client.tax_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.tax_system","typeLabel":"string | null"},"efos":{"oneOf":[{"type":"object","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":true,"description":"true = RFC is NOT on the EFOS (Art. 69-B) blacklist (safe). false = RFC appears on the blacklist.","uniqueKey":"data.oneOf.0.client.efos.oneOf.0.is_valid.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"description":"true = RFC is NOT on the EFOS (Art. 69-B) blacklist (safe). false = RFC appears on the blacklist.","uniqueKey":"data.oneOf.0.client.efos.oneOf.0.is_valid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.efos.oneOf.0.is_valid","typeLabel":"boolean | null"}},"description":"EFOS (Art. 69-B CFF) blacklist check. Independent from `fiscal_validation` — an RFC can fail one and pass the other.","uniqueKey":"data.oneOf.0.client.efos.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":true,"description":"true = RFC is NOT on the EFOS (Art. 69-B) blacklist (safe). false = RFC appears on the blacklist."},{"type":"null","example":true,"description":"true = RFC is NOT on the EFOS (Art. 69-B) blacklist (safe). false = RFC appears on the blacklist."}]}},"description":"EFOS (Art. 69-B CFF) blacklist check. Independent from `fiscal_validation` — an RFC can fail one and pass the other.","uniqueKey":"data.oneOf.0.client.efos.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.efos","typeLabel":"object | null"},"fiscal_validation":{"oneOf":[{"type":"object","description":"Result of attempting to stamp a test CFDI against the PAC. Only returned on create/update/validate; not persisted on the client doc.","properties":{"status":{"type":"string","enum":["valid","not_valid","skipped"],"example":"not_valid","description":"`valid` = PAC accepted; `not_valid` = PAC rejected (RFC/legal_name/CP do not match SAT registry); `skipped` = required fields missing.","uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.0.status","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","example":"Fiscal info validation failed. El campo DomicilioFiscalReceptor del receptor, debe pertenecer al nombre asociado al RFC registrado en el campo Rfc del Receptor.","description":"Human-readable reason when status is not_valid or skipped.","uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","example":"Fiscal info validation failed. El campo DomicilioFiscalReceptor del receptor, debe pertenecer al nombre asociado al RFC registrado en el campo Rfc del Receptor.","description":"Human-readable reason when status is not_valid or skipped.","uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.0.message","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Result of attempting to stamp a test CFDI against the PAC. Only returned on create/update/validate; not persisted on the client doc.","properties":{"status":{"type":"string","enum":["valid","not_valid","skipped"],"example":"not_valid","description":"`valid` = PAC accepted; `not_valid` = PAC rejected (RFC/legal_name/CP do not match SAT registry); `skipped` = required fields missing."},"message":{"oneOf":[{"type":"string","example":"Fiscal info validation failed. El campo DomicilioFiscalReceptor del receptor, debe pertenecer al nombre asociado al RFC registrado en el campo Rfc del Receptor.","description":"Human-readable reason when status is not_valid or skipped."},{"type":"null","example":"Fiscal info validation failed. El campo DomicilioFiscalReceptor del receptor, debe pertenecer al nombre asociado al RFC registrado en el campo Rfc del Receptor.","description":"Human-readable reason when status is not_valid or skipped."}]}},"uniqueKey":"data.oneOf.0.client.fiscal_validation.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.fiscal_validation","typeLabel":"object | null"},"sat_status":{"oneOf":[{"type":"object","description":"Unified SAT risk signal combining the EFOS check with 20 SAT Datos Abiertos lists (Art. 69, 69-B, 69-B Bis)\nsynced weekly into Firestore. A hit on any \"risky\" list (Cancelados, No localizados, CSD sin efectos, Definitivos 69-B,\nPresuntos 69-B, etc.) or a failed EFOS check sets `is_risky: true`.\n","properties":{"is_risky":{"type":"boolean","example":true,"description":"true if any risky list hit OR `efos.is_valid === false`.","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.is_risky","typeLabel":"boolean"},"efos":{"oneOf":[{"type":"object","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":false,"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos.oneOf.0.is_valid.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos.oneOf.0.is_valid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos.oneOf.0.is_valid","typeLabel":"boolean | null"}},"description":"EFOS check result (duplicated here for convenience).","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":false},{"type":"null","example":false}]}},"description":"EFOS check result (duplicated here for convenience).","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.efos","typeLabel":"object | null"},"hits":{"type":"array","description":"Every SAT list the RFC appears on, with the full row from the source CSV.","items":{"type":"object","properties":{"list":{"type":"string","example":"art_69b_definitivos","description":"List key (matches the source filename). See /sat_rfc_list_entries for all.","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX].list","typeLabel":"string"},"label":{"type":"string","example":"Definitivos 69-B","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX].label","typeLabel":"string"},"source":{"type":"string","enum":["art_69","art_69b","art_69b_bis"],"example":"art_69b","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"is_risky":{"type":"boolean","example":true,"description":"Whether a hit on this specific list marks the RFC unsafe.","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX].is_risky","typeLabel":"boolean"},"detail":{"type":"object","additionalProperties":true,"description":"Full SAT record (razón social, situación, dates, oficios DOF, etc.). Shape varies per list.","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX].detail","typeLabel":"object"}},"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.hits","typeLabel":"object[]"},"checked_at":{"type":"number","example":1776887458784,"description":"Unix timestamp (ms) of when this check was run.","uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0.checked_at","typeLabel":"number"}},"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.0","typeLabel":"object"},{"type":"null","description":"Unified SAT risk signal combining the EFOS check with 20 SAT Datos Abiertos lists (Art. 69, 69-B, 69-B Bis)\nsynced weekly into Firestore. A hit on any \"risky\" list (Cancelados, No localizados, CSD sin efectos, Definitivos 69-B,\nPresuntos 69-B, etc.) or a failed EFOS check sets `is_risky: true`.\n","properties":{"is_risky":{"type":"boolean","example":true,"description":"true if any risky list hit OR `efos.is_valid === false`."},"efos":{"oneOf":[{"type":"object","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":false},{"type":"null","example":false}]}},"description":"EFOS check result (duplicated here for convenience)."},{"type":"null","properties":{"is_valid":{"oneOf":[{"type":"boolean","example":false},{"type":"null","example":false}]}},"description":"EFOS check result (duplicated here for convenience)."}]},"hits":{"type":"array","description":"Every SAT list the RFC appears on, with the full row from the source CSV.","items":{"type":"object","properties":{"list":{"type":"string","example":"art_69b_definitivos","description":"List key (matches the source filename). See /sat_rfc_list_entries for all."},"label":{"type":"string","example":"Definitivos 69-B"},"source":{"type":"string","enum":["art_69","art_69b","art_69b_bis"],"example":"art_69b"},"is_risky":{"type":"boolean","example":true,"description":"Whether a hit on this specific list marks the RFC unsafe."},"detail":{"type":"object","additionalProperties":true,"description":"Full SAT record (razón social, situación, dates, oficios DOF, etc.). Shape varies per list."}}}},"checked_at":{"type":"number","example":1776887458784,"description":"Unix timestamp (ms) of when this check was run."}},"uniqueKey":"data.oneOf.0.client.sat_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.sat_status","typeLabel":"object | null"},"defaults":{"oneOf":[{"type":"object","properties":{"keep_full_legal_name":{"oneOf":[{"type":"boolean","example":false,"description":"Keep full legal name in documents","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.keep_full_legal_name.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Keep full legal name in documents","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.keep_full_legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.keep_full_legal_name","typeLabel":"boolean | null"},"issue_automatic_invoices":{"oneOf":[{"type":"boolean","example":false,"description":"Issue automatic invoices","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_automatic_invoices.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Issue automatic invoices","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_automatic_invoices.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_automatic_invoices","typeLabel":"boolean | null"},"issue_invoiceable_receipts":{"oneOf":[{"type":"boolean","example":true,"description":"Issue invoiceable receipts","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_invoiceable_receipts.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"description":"Issue invoiceable receipts","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_invoiceable_receipts.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.defaults.oneOf.0.issue_invoiceable_receipts","typeLabel":"boolean | null"}},"description":"Client default settings","uniqueKey":"data.oneOf.0.client.defaults.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"keep_full_legal_name":{"oneOf":[{"type":"boolean","example":false,"description":"Keep full legal name in documents"},{"type":"null","example":false,"description":"Keep full legal name in documents"}]},"issue_automatic_invoices":{"oneOf":[{"type":"boolean","example":false,"description":"Issue automatic invoices"},{"type":"null","example":false,"description":"Issue automatic invoices"}]},"issue_invoiceable_receipts":{"oneOf":[{"type":"boolean","example":true,"description":"Issue invoiceable receipts"},{"type":"null","example":true,"description":"Issue invoiceable receipts"}]}},"description":"Client default settings","uniqueKey":"data.oneOf.0.client.defaults.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.defaults","typeLabel":"object | null"},"document_type":{"oneOf":[{"type":"string","description":"Colombia (DIAN) only: identification document code (`11`, `12`, `13`, `21`, `22`, `31`, `41`, `42`, `47`, `48`, `50`, `91`).","uniqueKey":"data.oneOf.0.client.document_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colombia (DIAN) only: identification document code (`11`, `12`, `13`, `21`, `22`, `31`, `41`, `42`, `47`, `48`, `50`, `91`).","uniqueKey":"data.oneOf.0.client.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.document_type","typeLabel":"string | null"},"organization_type":{"oneOf":[{"type":"integer","description":"Colombia (DIAN) only: `1` legal entity, `2` natural person.","uniqueKey":"data.oneOf.0.client.organization_type.oneOf.0","typeLabel":"integer"},{"type":"string","description":"Colombia (DIAN) only: `1` legal entity, `2` natural person.","uniqueKey":"data.oneOf.0.client.organization_type.oneOf.1","typeLabel":"string"},{"type":"object","enum":[null],"uniqueKey":"data.oneOf.0.client.organization_type.oneOf.2","typeLabel":"object"},{"type":"null","enum":[null],"uniqueKey":"data.oneOf.0.client.organization_type.oneOf.3","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.organization_type","typeLabel":"integer | string | object | null"},"tribute_code":{"oneOf":[{"type":"string","description":"Colombia (DIAN) only: `01` IVA responsible, `ZZ` not applicable.","uniqueKey":"data.oneOf.0.client.tribute_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colombia (DIAN) only: `01` IVA responsible, `ZZ` not applicable.","uniqueKey":"data.oneOf.0.client.tribute_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.tribute_code","typeLabel":"string | null"},"fiscal_responsibilities":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.client.fiscal_responsibilities.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Colombia (DIAN) only: fiscal responsibilities (list 53), e.g. `O-13`, `R-99-PN`.","uniqueKey":"data.oneOf.0.client.fiscal_responsibilities.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Colombia (DIAN) only: fiscal responsibilities (list 53), e.g. `O-13`, `R-99-PN`.","uniqueKey":"data.oneOf.0.client.fiscal_responsibilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.fiscal_responsibilities","typeLabel":"string[] | null"},"dv":{"oneOf":[{"type":"string","description":"Colombia (DIAN) only: NIT verification digit (informational).","uniqueKey":"data.oneOf.0.client.dv.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colombia (DIAN) only: NIT verification digit (informational).","uniqueKey":"data.oneOf.0.client.dv.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.dv","typeLabel":"string | null"},"municipality_code":{"oneOf":[{"type":"string","description":"Colombia (DIAN) only: 5-digit DANE municipality code.","uniqueKey":"data.oneOf.0.client.municipality_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Colombia (DIAN) only: 5-digit DANE municipality code.","uniqueKey":"data.oneOf.0.client.municipality_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.client.municipality_code","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0.client","typeLabel":"object"},"currency":{"type":"string","example":"MXN","description":"Payment currency","isRequired":true,"uniqueKey":"data.oneOf.0.currency","typeLabel":"string"},"exchange_rate":{"type":"number","example":1,"description":"Exchange rate used for currency conversion","isRequired":true,"uniqueKey":"data.oneOf.0.exchange_rate","typeLabel":"number"},"items":{"type":"array","items":{"type":"object","required":["team","created_at"],"properties":{"team":{"type":"string","example":"team_1234567890","description":"Team ID this service belongs to","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].team","typeLabel":"string"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of service creation","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].created_at","typeLabel":"number"},"id":{"oneOf":[{"type":"string","example":"service_1234567890","description":"Unique service identifier","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","example":"service_1234567890","description":"Unique service identifier","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Consulting services","description":"Service description","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Consulting services","description":"Service description","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].description","typeLabel":"string | null"},"from":{"oneOf":[{"type":"string","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].from.oneOf.0","typeLabel":"string"},{"type":"null","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].from.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].from","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","example":"CONS-001","description":"Stock Keeping Unit identifier","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","example":"CONS-001","description":"Stock Keeping Unit identifier","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].sku","typeLabel":"string | null"},"product_key":{"oneOf":[{"type":"string","example":"80141503","description":"SAT product key for tax compliance","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].product_key.oneOf.0","typeLabel":"string"},{"type":"null","example":"80141503","description":"SAT product key for tax compliance","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].product_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].product_key","typeLabel":"string | null"},"unit_key":{"oneOf":[{"type":"string","example":"E48","description":"SAT unit key for tax compliance","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_key.oneOf.0","typeLabel":"string"},{"type":"null","example":"E48","description":"SAT unit key for tax compliance","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_key","typeLabel":"string | null"},"unit_name":{"oneOf":[{"type":"string","example":"Servicio","description":"Unit name for the service","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Servicio","description":"Unit name for the service","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_name","typeLabel":"string | null"},"unit_price":{"oneOf":[{"type":"number","example":1000,"description":"Price per unit","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_price.oneOf.0","typeLabel":"number"},{"type":"null","example":1000,"description":"Price per unit","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"number | null"},"taxes":{"oneOf":[{"type":"array","items":{"type":"object","required":["type","rate"],"properties":{"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].rate","typeLabel":"number"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.0","typeLabel":"number"},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.1","typeLabel":"null"},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.2","typeLabel":"string"},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.3","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].base","typeLabel":"number · null · string · null"},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor.oneOf.0","typeLabel":"string"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor","typeLabel":"string | null"},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive","typeLabel":"boolean | null"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether this is a withholding tax","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding","typeLabel":"boolean | null"}},"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tax configuration for this service","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["type","rate"],"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100}]},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"}]},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price"}]},"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax"},{"type":"null","example":false,"description":"Whether this is a withholding tax"}]}}},"description":"Tax configuration for this service","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].taxes","typeLabel":"object[] | null"},"quantity":{"oneOf":[{"type":"number","example":1,"description":"Quantity (used in transactions)","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].quantity.oneOf.0","typeLabel":"number"},{"type":"null","example":1,"description":"Quantity (used in transactions)","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"number | null"},"discount":{"oneOf":[{"type":"number","description":"Discount applied to the item.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].discount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Discount applied to the item.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].discount","typeLabel":"number | null"},"third_party":{"type":"object","description":"Third party on whose behalf the item is billed (A cuenta de terceros).","required":["legal_name","tax_id","tax_system","zip"],"properties":{"legal_name":{"type":"string","description":"Legal name of the third party","example":"Third Party SA de CV","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].third_party.legal_name","typeLabel":"string"},"tax_id":{"type":"string","description":"RFC (Tax ID) of the third party","example":"TPR800101ABC","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].third_party.tax_id","typeLabel":"string"},"tax_system":{"type":"string","description":"SAT tax system code","example":"601","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].third_party.tax_system","typeLabel":"string"},"zip":{"type":"string","description":"Postal code of the third party","example":"03100","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].third_party.zip","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].third_party","typeLabel":"object"},"item_complement":{"oneOf":[{"type":"object","description":"Item-level CFDI complement, when configured.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].item_complement.oneOf.0","typeLabel":"object"},{"type":"null","description":"Item-level CFDI complement, when configured.","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].item_complement.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].item_complement","typeLabel":"object | null"},"search":{"type":"object","required":["on_key","on_value","auto_create"],"properties":{"on_key":{"type":"string","example":"tax_id","description":"Field to search on","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].search.on_key","typeLabel":"string"},"on_value":{"type":"string","example":"PEGJ800101ABC","description":"Value to search for","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].search.on_value","typeLabel":"string"},"auto_create":{"type":"boolean","example":true,"description":"Whether to create the resource if not found","isRequired":true,"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].search.auto_create","typeLabel":"boolean"},"safety_check":{"type":"boolean","example":false,"description":"When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false","uniqueKey":"data.oneOf.0.\\items.items.[INDEX].search.safety_check","typeLabel":"boolean"}},"uniqueKey":"data.oneOf.0.\\items.items.[INDEX].search","typeLabel":"object"}},"uniqueKey":"data.oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"description":"Items included in this payment","isRequired":true,"uniqueKey":"data.oneOf.0.\\items","typeLabel":"object[]"},"team":{"type":"string","example":"team_1234567890","description":"Team ID this payment belongs to","isRequired":true,"uniqueKey":"data.oneOf.0.team","typeLabel":"string"},"idempotency_key":{"type":"string","example":"unique_key_123","description":"Idempotency key to prevent duplicate payments","isRequired":true,"uniqueKey":"data.oneOf.0.idempotency_key","typeLabel":"string"},"from":{"type":"string","example":"api","description":"Source of payment creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","isRequired":true,"uniqueKey":"data.oneOf.0.from","typeLabel":"string"},"invoices":{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.invoices.items.[INDEX]","typeLabel":"string"},"example":["B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB"],"description":"Associated invoice ids. Invoices stamped by the API are stored under their SAT UUID (folio fiscal).","isRequired":true,"uniqueKey":"data.oneOf.0.invoices","typeLabel":"string[]"},"livemode":{"type":"boolean","example":true,"description":"Whether this payment is in live mode","isRequired":true,"uniqueKey":"data.oneOf.0.livemode","typeLabel":"boolean"},"owner":{"type":"string","example":"user_1234567890","description":"User ID who owns this payment","isRequired":true,"uniqueKey":"data.oneOf.0.owner","typeLabel":"string"},"payment_form":{"type":"string","example":"03","description":"SAT payment form code","isRequired":true,"uniqueKey":"data.oneOf.0.payment_form","typeLabel":"string"},"payments":{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.payments.items.[INDEX]","typeLabel":"string"},"example":[],"description":"Related payment IDs","isRequired":true,"uniqueKey":"data.oneOf.0.payments","typeLabel":"string[]"},"receipts":{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.receipts.items.[INDEX]","typeLabel":"string"},"example":["receipt_1234567890"],"description":"Associated receipt IDs","isRequired":true,"uniqueKey":"data.oneOf.0.receipts","typeLabel":"string[]"},"refunds":{"type":"array","items":{"type":"object","required":["id","reason","created_at","total"],"properties":{"id":{"type":"string","example":"refund_1234567890","description":"Unique refund identifier","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].id","typeLabel":"string"},"reason":{"description":"Reason for the refund","example":"Customer requested cancellation","type":"string","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].reason","typeLabel":"string"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of when the refund was created","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].created_at","typeLabel":"number"},"total":{"type":"number","example":1160,"description":"Total refund amount","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].total","typeLabel":"number"},"items":{"oneOf":[{"type":"array","items":{"type":"object","required":["team","created_at"],"properties":{"team":{"type":"string","example":"team_1234567890","description":"Team ID this service belongs to","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].team","typeLabel":"string"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of service creation","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].created_at","typeLabel":"number"},"id":{"oneOf":[{"type":"string","example":"service_1234567890","description":"Unique service identifier","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","example":"service_1234567890","description":"Unique service identifier","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":"Consulting services","description":"Service description","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","example":"Consulting services","description":"Service description","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"from":{"oneOf":[{"type":"string","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].from.oneOf.0","typeLabel":"string"},{"type":"null","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].from.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].from","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","example":"CONS-001","description":"Stock Keeping Unit identifier","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","example":"CONS-001","description":"Stock Keeping Unit identifier","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"product_key":{"oneOf":[{"type":"string","example":"80141503","description":"SAT product key for tax compliance","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_key.oneOf.0","typeLabel":"string"},{"type":"null","example":"80141503","description":"SAT product key for tax compliance","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].product_key","typeLabel":"string | null"},"unit_key":{"oneOf":[{"type":"string","example":"E48","description":"SAT unit key for tax compliance","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_key.oneOf.0","typeLabel":"string"},{"type":"null","example":"E48","description":"SAT unit key for tax compliance","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_key","typeLabel":"string | null"},"unit_name":{"oneOf":[{"type":"string","example":"Servicio","description":"Unit name for the service","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Servicio","description":"Unit name for the service","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_name","typeLabel":"string | null"},"unit_price":{"oneOf":[{"type":"number","example":1000,"description":"Price per unit","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price.oneOf.0","typeLabel":"number"},{"type":"null","example":1000,"description":"Price per unit","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].unit_price","typeLabel":"number | null"},"taxes":{"oneOf":[{"type":"array","items":{"type":"object","required":["type","rate"],"properties":{"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].rate","typeLabel":"number"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax","isRequired":true,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.0","typeLabel":"number"},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.1","typeLabel":"null"},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.2","typeLabel":"string"},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100,"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].base.oneOf.3","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].base","typeLabel":"number · null · string · null"},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor.oneOf.0","typeLabel":"string"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].factor","typeLabel":"string | null"},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].inclusive","typeLabel":"boolean | null"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"description":"Whether this is a withholding tax","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX].withholding","typeLabel":"boolean | null"}},"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tax configuration for this service","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["type","rate"],"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100}]},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"}]},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price"}]},"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax"},{"type":"null","example":false,"description":"Whether this is a withholding tax"}]}}},"description":"Tax configuration for this service","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].taxes","typeLabel":"object[] | null"},"quantity":{"oneOf":[{"type":"number","example":1,"description":"Quantity (used in transactions)","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity.oneOf.0","typeLabel":"number"},{"type":"null","example":1,"description":"Quantity (used in transactions)","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].quantity","typeLabel":"number | null"},"discount":{"oneOf":[{"type":"number","description":"Discount applied to the item.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].discount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Discount applied to the item.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].discount","typeLabel":"number | null"},"third_party":{"oneOf":[{"type":"object","description":"Third party on whose behalf the item is billed (A cuenta de terceros).","properties":{"legal_name":{"type":"string","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.0.legal_name","typeLabel":"string"},"tax_id":{"type":"string","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.0.tax_id","typeLabel":"string"},"tax_system":{"type":"string","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.0.tax_system","typeLabel":"string"},"zip":{"type":"string","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.0.zip","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.0","typeLabel":"object"},{"type":"null","description":"Third party on whose behalf the item is billed (A cuenta de terceros).","properties":{"legal_name":{"type":"string"},"tax_id":{"type":"string"},"tax_system":{"type":"string"},"zip":{"type":"string"}},"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].third_party","typeLabel":"object | null"},"item_complement":{"oneOf":[{"type":"object","description":"Item-level CFDI complement, when configured.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].item_complement.oneOf.0","typeLabel":"object"},{"type":"null","description":"Item-level CFDI complement, when configured.","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].item_complement.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX].item_complement","typeLabel":"object | null"}},"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Items being refunded","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["team","created_at"],"properties":{"id":{"oneOf":[{"type":"string","example":"service_1234567890","description":"Unique service identifier"},{"type":"null","example":"service_1234567890","description":"Unique service identifier"}]},"description":{"oneOf":[{"type":"string","example":"Consulting services","description":"Service description"},{"type":"null","example":"Consulting services","description":"Service description"}]},"from":{"oneOf":[{"type":"string","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically."},{"type":"null","example":"api","description":"Source of service creation. Documents created through the public API are stored with `api`; requests carrying the `X-Gigstack-Client: mcp` header (the gigstack MCP server) are stored with `mcp` and behave identically."}]},"sku":{"oneOf":[{"type":"string","example":"CONS-001","description":"Stock Keeping Unit identifier"},{"type":"null","example":"CONS-001","description":"Stock Keeping Unit identifier"}]},"product_key":{"oneOf":[{"type":"string","example":"80141503","description":"SAT product key for tax compliance"},{"type":"null","example":"80141503","description":"SAT product key for tax compliance"}]},"unit_key":{"oneOf":[{"type":"string","example":"E48","description":"SAT unit key for tax compliance"},{"type":"null","example":"E48","description":"SAT unit key for tax compliance"}]},"unit_name":{"oneOf":[{"type":"string","example":"Servicio","description":"Unit name for the service"},{"type":"null","example":"Servicio","description":"Unit name for the service"}]},"unit_price":{"oneOf":[{"type":"number","example":1000,"description":"Price per unit"},{"type":"null","example":1000,"description":"Price per unit"}]},"taxes":{"oneOf":[{"type":"array","items":{"type":"object","required":["type","rate"],"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100}]},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"}]},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price"}]},"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax"},{"type":"null","example":false,"description":"Whether this is a withholding tax"}]}}},"description":"Tax configuration for this service"},{"type":"null","items":{"type":"object","required":["type","rate"],"properties":{"base":{"oneOf":[{"type":"number","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"string","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100},{"type":"null","description":"Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price.","example":100}]},"factor":{"oneOf":[{"type":"string","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"},{"type":"null","example":"Tasa","description":"SAT tax factor (Tasa, Cuota, Exento)"}]},"inclusive":{"oneOf":[{"type":"boolean","example":false,"description":"Whether the tax is included in the unit price"},{"type":"null","example":false,"description":"Whether the tax is included in the unit price"}]},"rate":{"type":"number","example":0.16,"description":"Tax rate (e.g., 0.16 for 16% IVA)"},"type":{"type":"string","enum":["IVA","ISR","IEPS"],"example":"IVA","description":"Type of tax"},"withholding":{"oneOf":[{"type":"boolean","example":false,"description":"Whether this is a withholding tax"},{"type":"null","example":false,"description":"Whether this is a withholding tax"}]}}},"description":"Tax configuration for this service"}]},"team":{"type":"string","example":"team_1234567890","description":"Team ID this service belongs to"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of service creation"},"quantity":{"oneOf":[{"type":"number","example":1,"description":"Quantity (used in transactions)"},{"type":"null","example":1,"description":"Quantity (used in transactions)"}]},"discount":{"oneOf":[{"type":"number","description":"Discount applied to the item."},{"type":"null","description":"Discount applied to the item."}]},"third_party":{"oneOf":[{"type":"object","description":"Third party on whose behalf the item is billed (A cuenta de terceros).","properties":{"legal_name":{"type":"string"},"tax_id":{"type":"string"},"tax_system":{"type":"string"},"zip":{"type":"string"}}},{"type":"null","description":"Third party on whose behalf the item is billed (A cuenta de terceros).","properties":{"legal_name":{"type":"string"},"tax_id":{"type":"string"},"tax_system":{"type":"string"},"zip":{"type":"string"}}}]},"item_complement":{"oneOf":[{"type":"object","description":"Item-level CFDI complement, when configured."},{"type":"null","description":"Item-level CFDI complement, when configured."}]}}},"description":"Items being refunded","uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.refunds.items.[INDEX].\\items","typeLabel":"object[] | null"}},"uniqueKey":"data.oneOf.0.refunds.items.[INDEX]","typeLabel":"object"},"description":"Refunds associated with this payment","isRequired":true,"uniqueKey":"data.oneOf.0.refunds","typeLabel":"object[]"},"short_url":{"type":"string","example":"https://gigstack.xyz/Xk3mP9","description":"Short URL for payment page","isRequired":true,"uniqueKey":"data.oneOf.0.short_url","typeLabel":"string"},"status":{"type":"string","enum":["requires_payment_method","succeeded","partially_paid","canceled"],"example":"succeeded","description":"Current payment status. `partially_paid` means the payment was topped up for\nless than its full amount via `POST /payments/{id}/paid` with `amount_received`\nset below the total — see that endpoint's `amount_received` field.\n","isRequired":true,"uniqueKey":"data.oneOf.0.status","typeLabel":"enum\u003cstring>"},"total":{"type":"number","example":1160,"description":"Total payment amount including taxes","isRequired":true,"uniqueKey":"data.oneOf.0.total","typeLabel":"number"},"total_refunded":{"type":"number","example":0,"description":"Cumulative refunds in minor units (cents), unlike total which is in currency units. Divide by 100 when comparing these fields for the documented MXN flow.","isRequired":true,"uniqueKey":"data.oneOf.0.total_refunded","typeLabel":"number"},"subtotal":{"type":"number","example":1000,"description":"Subtotal before taxes","isRequired":true,"uniqueKey":"data.oneOf.0.subtotal","typeLabel":"number"},"taxes":{"type":"number","example":160,"description":"Total tax amount","isRequired":true,"uniqueKey":"data.oneOf.0.taxes","typeLabel":"number"},"discount":{"type":"number","example":0,"description":"Discount applied","isRequired":true,"uniqueKey":"data.oneOf.0.discount","typeLabel":"number"},"withholding_taxes":{"type":"number","example":0,"description":"Withholding taxes amount","isRequired":true,"uniqueKey":"data.oneOf.0.withholding_taxes","typeLabel":"number"},"created_at":{"type":"number","example":1677651234,"description":"Unix timestamp of payment creation","isRequired":true,"uniqueKey":"data.oneOf.0.created_at","typeLabel":"number"},"succeeded_at":{"oneOf":[{"type":"number","example":1677651234,"description":"Unix timestamp when payment succeeded","isRequired":true,"uniqueKey":"data.oneOf.0.succeeded_at.oneOf.0","typeLabel":"number"},{"type":"null","example":1677651234,"description":"Unix timestamp when payment succeeded","isRequired":true,"uniqueKey":"data.oneOf.0.succeeded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.succeeded_at","typeLabel":"number | null"},"payment_processor":{"type":"string","example":"stripe","description":"Payment processor used","isRequired":true,"uniqueKey":"data.oneOf.0.payment_processor","typeLabel":"string"},"emails":{"oneOf":[{"type":"array","items":{"type":"string","format":"email","uniqueKey":"data.oneOf.0.emails.oneOf.0.items.[INDEX]","typeLabel":"string\u003cemail>"},"example":["client@example.com"],"description":"Email addresses to notify","uniqueKey":"data.oneOf.0.emails.oneOf.0","typeLabel":"string\u003cemail>[]"},{"type":"null","items":{"type":"string","format":"email"},"example":["client@example.com"],"description":"Email addresses to notify","uniqueKey":"data.oneOf.0.emails.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.emails","typeLabel":"string\u003cemail>[] | null"},"allowed_payment_methods":{"oneOf":[{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"card","description":"Payment method identifier","isRequired":true,"uniqueKey":"data.oneOf.0.allowed_payment_methods.oneOf.0.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.allowed_payment_methods.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Allowed payment methods","uniqueKey":"data.oneOf.0.allowed_payment_methods.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"card","description":"Payment method identifier"}}},"description":"Allowed payment methods","uniqueKey":"data.oneOf.0.allowed_payment_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.allowed_payment_methods","typeLabel":"object[] | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.oneOf.0.metadata.additionalProperties","typeLabel":"string"},"example":{"order_id":"12345"},"description":"Additional metadata for the payment","uniqueKey":"data.oneOf.0.metadata","typeLabel":"object"},"invoice_config":{"type":"object","properties":{"serie":{"oneOf":[{"type":"string","example":"A","description":"Invoice series","uniqueKey":"data.oneOf.0.invoice_config.serie.oneOf.0","typeLabel":"string"},{"type":"null","example":"A","description":"Invoice series","uniqueKey":"data.oneOf.0.invoice_config.serie.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.invoice_config.serie","typeLabel":"string | null"},"folio":{"oneOf":[{"type":"string","example":"123","description":"Invoice folio number","uniqueKey":"data.oneOf.0.invoice_config.folio.oneOf.0","typeLabel":"string"},{"type":"null","example":"123","description":"Invoice folio number","uniqueKey":"data.oneOf.0.invoice_config.folio.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.invoice_config.folio","typeLabel":"string | null"}},"uniqueKey":"data.oneOf.0.invoice_config","typeLabel":"object"},"success_url":{"oneOf":[{"type":"string","example":"https://tienda.com/pedido/1234/gracias","description":"Where the payment page returns the payer after a successful payment. Null when not set.","uniqueKey":"data.oneOf.0.success_url.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://tienda.com/pedido/1234/gracias","description":"Where the payment page returns the payer after a successful payment. Null when not set.","uniqueKey":"data.oneOf.0.success_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.success_url","typeLabel":"string | null"},"payment_processor_details":{"type":"object","additionalProperties":{"type":"object","properties":{"payment_intent":{"type":"string","example":"pi_1234567890","description":"Payment processor intent ID","uniqueKey":"data.oneOf.0.payment_processor_details.additionalProperties.payment_intent","typeLabel":"string"},"charge":{"type":"string","example":"ch_1234567890","description":"Payment processor charge ID","uniqueKey":"data.oneOf.0.payment_processor_details.additionalProperties.charge","typeLabel":"string"},"invoice":{"type":"string","example":"in_1234567890","description":"Payment processor invoice ID","uniqueKey":"data.oneOf.0.payment_processor_details.additionalProperties.invoice","typeLabel":"string"}},"uniqueKey":"data.oneOf.0.payment_processor_details.additionalProperties","typeLabel":"object"},"example":{"stripe":{"payment_intent":"pi_1234567890","charge":"ch_1234567890","invoice":"in_1234567890"}},"uniqueKey":"data.oneOf.0.payment_processor_details","typeLabel":"object"},"transfer_data":{"oneOf":[{"type":"object","description":"Split-payment transfer configuration (gigstack Connect marketplaces).","uniqueKey":"data.oneOf.0.transfer_data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Split-payment transfer configuration (gigstack Connect marketplaces).","uniqueKey":"data.oneOf.0.transfer_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.transfer_data","typeLabel":"object | null"},"split_reference":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.split_reference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.split_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.split_reference","typeLabel":"string | null"},"split_role":{"oneOf":[{"type":"string","enum":["master","connect",null],"uniqueKey":"data.oneOf.0.split_role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["master","connect",null],"uniqueKey":"data.oneOf.0.split_role.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.split_role","typeLabel":"enum\u003cstring> | null"},"counterpart_payment_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.counterpart_payment_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.counterpart_payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.counterpart_payment_id","typeLabel":"string | null"},"original_transfer_data":{"oneOf":[{"type":"object","uniqueKey":"data.oneOf.0.original_transfer_data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.0.original_transfer_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.original_transfer_data","typeLabel":"object | null"},"split_payment_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.split_payment_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.split_payment_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"data.oneOf.0.split_payment_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.split_payment_ids","typeLabel":"string[] | null"},"parent_payment_id":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.parent_payment_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.parent_payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.parent_payment_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"object","description":"Split payment result (returned when `transfer_data` is present)","properties":{"split_reference":{"type":"string","example":"split_abc123xyz","uniqueKey":"data.oneOf.1.split_reference","typeLabel":"string"},"master_payment_id":{"type":"string","example":"payment_master_123","uniqueKey":"data.oneOf.1.master_payment_id","typeLabel":"string"},"connect_payment_id":{"type":"string","example":"payment_connect_456","uniqueKey":"data.oneOf.1.connect_payment_id","typeLabel":"string"},"master_amount":{"type":"number","example":696,"uniqueKey":"data.oneOf.1.master_amount","typeLabel":"number"},"connect_amount":{"type":"number","example":464,"uniqueKey":"data.oneOf.1.connect_amount","typeLabel":"number"},"total_amount":{"type":"number","example":1160,"uniqueKey":"data.oneOf.1.total_amount","typeLabel":"number"},"master_payment":{"type":"object","uniqueKey":"data.oneOf.1.master_payment","typeLabel":"object"},"connect_payment":{"type":"object","uniqueKey":"data.oneOf.1.connect_payment","typeLabel":"object"},"connect_team":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.oneOf.1.connect_team.oneOf.0.id","typeLabel":"string"},"tax_id":{"type":"string","uniqueKey":"data.oneOf.1.connect_team.oneOf.0.tax_id","typeLabel":"string"},"legal_name":{"type":"string","uniqueKey":"data.oneOf.1.connect_team.oneOf.0.legal_name","typeLabel":"string"},"is_newly_created":{"type":"boolean","uniqueKey":"data.oneOf.1.connect_team.oneOf.0.is_newly_created","typeLabel":"boolean"},"onboarding_url":{"type":"string","uniqueKey":"data.oneOf.1.connect_team.oneOf.0.onboarding_url","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.connect_team.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"tax_id":{"type":"string"},"legal_name":{"type":"string"},"is_newly_created":{"type":"boolean"},"onboarding_url":{"type":"string"}},"uniqueKey":"data.oneOf.1.connect_team.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.connect_team","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"object"}],"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":"`Payment registered successfully` on the standard path, `Split payments registered successfully` on the split path.","example":"Payment registered successfully","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"standard_payment":{"title":"standard_payment","summary":"Standard payment response","value":{"success":true,"message":"Payment registered successfully","timestamp":1767225600000,"data":{"id":"payment_1234567890","client":{"id":"client_1234567890","name":"Juan Pérez García","email":"juan.perez@ejemplo.com","tax_id":"PEGJ800101ABC"},"status":"succeeded","currency":"MXN","exchange_rate":1,"payment_form":"03","total":1160,"subtotal":1000,"taxes":160,"discount":0,"items":[{"id":"service_1234567890","description":"Professional consulting services","quantity":1,"unit_price":1000,"product_key":"80141503","unit_key":"E48"}],"invoices":["B0C3E4F2-1A2B-4C5D-9E8F-0123456789AB"],"created_at":1677651234,"succeeded_at":1677651234,"payment_processor":"api","livemode":true,"team":"team_1234567890","owner":"user_1234567890"}}},"split_payment":{"title":"split_payment","summary":"Split payment response","description":"Response when using transfer_data to split payments","value":{"success":true,"message":"Split payments registered successfully","timestamp":1767225600000,"data":{"split_reference":"split_abc123xyz","master_payment_id":"payment_master_123","connect_payment_id":"payment_connect_456","master_amount":696,"connect_amount":464,"total_amount":1160,"master_payment":{"id":"payment_master_123","client":"client_1234567890","amount":696,"team":"team_master_123","split_role":"master"},"connect_payment":{"id":"payment_connect_456","client":"client_connect_789","amount":464,"team":"team_connect_456","split_role":"connect"},"connect_team":{"id":"team_connect_456","tax_id":"EMP800101ABC","legal_name":"Empresa Ejemplo SA de CV","is_newly_created":true,"onboarding_url":"https://embeded.gigstack.pro/?sessionId=otpOnboarding_7Kd2Pq\u0026c=193847"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"8a30d7bf-1abc-4c2d-b470-98e73baced74":{"description":"Bad Request. Emitted with `error.code`:\n- `validation_failed` — body failed schema validation (missing required field,\n bad enum value, or an unknown key: the validator rejects fields it does not declare).\n- `invalid_request_body` — `Invalid automation type`, `PPD invoice not found with uuid: …`,\n `The referenced invoice is not valid (stamped)`, `Payment date cannot be in the future`,\n or `Exchange rate not found for the specified currency`.\n","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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"validation_failed","message":"Request validation failed","details":["currency: Field is required","client_id: Unexpected field"]},"timestamp":1767225600000}}},"exampleType":"generated"}},"exampleType":"generated"},"6670f83f-59c2-4419-b689-dd6a5fb84c26":{"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"},"0359804c-0a8e-460f-abc2-bdfa2d35bc73":{"description":"Forbidden — the referenced client or service belongs to another team, or its\n`livemode` does not match the API key. Raised by resource resolution with\n`error.code: resource_resolution_failed`.\n","content":{"application/json":{"schema":{"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"],"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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"validation_failed","message":"Request validation failed","details":["currency: Field is required"]},"timestamp":1767225600000}}},"exampleType":"generated"}},"exampleType":"generated"},"61af16a8-7761-4c27-a491-64e8e850872d":{"description":"Referenced client or service id was not found.","content":{"application/json":{"schema":{"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":"resource_not_found","message":"Resource not found"},"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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"resource_not_found","message":"Resource not found"},"timestamp":1767225600000}}},"exampleType":"generated"}},"exampleType":"generated"},"ed04d438-256b-4cbe-b838-2d3a58c9928a":{"description":"Conflict — the supplied `idempotency_key` has already been used\n(`error.code: resource_conflict`, message `Idempotency key error`). On the split\npath either the master or the connect payment can trigger this. Resource\nresolution also returns 409 when a concurrent create for the same client/service\nholds the lock; retry the request. A 409 with message `Idempotency key in progress`\nmeans another request with the same `idempotency_key` is still writing its payment\n(the key is claimed in a transaction before the write, so two concurrent requests\nnever register two payments): read the payment back by its key, or retry shortly.\n","content":{"application/json":{"schema":{"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"],"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":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"validation_failed","message":"Request validation failed","details":["currency: Field is required"]},"timestamp":1767225600000}}},"exampleType":"generated"}},"exampleType":"generated"},"03bf8aed-64d6-454f-a59b-3d909157b51a":{"description":"Unexpected server error (`error.code: internal_server_error`). The failure is logged on gigstack's side.","content":{"application/json":{"schema":{"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"],"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"},"example":{"success":false,"error":{"code":"internal_server_error","message":"An internal server error occurred"},"timestamp":1767225600000},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"internal_server_error","message":"An internal server error occurred"},"timestamp":1767225600000}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"82eec3c6-96e9-431c-81f4-b3b48ce5f69b":{"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":"Register payment (you were already paid) - gigstack","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T23:43:47.376Z","originalFileLocation":"reference/createPaymentsRegister.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=\"Small working example Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished. Use this when you were already paid (cash, bank transfer, or any payment received outside gigstack): it records the payment as succeeded and runs its automations, such as issuing the invoice, right away. No payment link is created and nobody is charged. To ask a customer to pay you, use POST /payments/request instead. gigstack Connect: Register payments for other teams using the team parameter. ## Automation Types Control what happens automatically when registering a payment: - pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately - none: No automation, registers payment only ## PPD Invoice Linking You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field. When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method=\u0026#x27;PPD\u0026#x27; and status=\u0026#x27;valid\u0026#x27;. ## Payment Form The payment_form field specifies the Mexican SAT payment form code: Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc. The payment will be marked as \u0026#x27;succeeded\u0026#x27; immediately upon registration. ## Required fields client, currency, items (at least one), payment_form and automation_type are required. automation_type has no default — omitting it fails validation. Allowed values: pue_invoice, ppd_invoice_and_complement, none. ## date Optional, in Unix epoch milliseconds (13 digits). Compared against Luxon.now().toMillis(); a future value returns 400. ## transfer_data — all-or-nothing transfer_data is optional, but when it is present all four of master, connect, master_to and connect_to are required; omitting any one fails validation. | field | type | constraint | |---|---|---| | master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) | | connect | string | required, non-empty — RFC of the connected team | | master_to | enum | required — client or connect | | connect_to | enum | required — client or master | | connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry | ## invoice_config All nested fields are optional: | field | type | meaning | |---|---|---| | serie | string | invoice series | | folio | number | invoice folio number | | date | number | invoice issue date, Unix epoch milliseconds | | global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 | | global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb | | global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly | | validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds | ## Email suppression ignore_emails: true suppresses notification emails. On this endpoint send_email is accepted but has no effect — only ignore_emails is persisted onto the payment. ## Unknown fields Body validation runs in strict allowlist mode — any undeclared key is rejected with 400 validation_failed / unexpected_key.\">\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=\"Register payment (you were already paid) - gigstack\">\u003cmeta data-mint-head property=\"og:description\" content=\"Small working example Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished. Use this when you were already paid (cash, bank transfer, or any payment received outside gigstack): it records the payment as succeeded and runs its automations, such as issuing the invoice, right away. No payment link is created and nobody is charged. To ask a customer to pay you, use POST /payments/request instead. gigstack Connect: Register payments for other teams using the team parameter. ## Automation Types Control what happens automatically when registering a payment: - pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately - none: No automation, registers payment only ## PPD Invoice Linking You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field. When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method=\u0026#x27;PPD\u0026#x27; and status=\u0026#x27;valid\u0026#x27;. ## Payment Form The payment_form field specifies the Mexican SAT payment form code: Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc. The payment will be marked as \u0026#x27;succeeded\u0026#x27; immediately upon registration. ## Required fields client, currency, items (at least one), payment_form and automation_type are required. automation_type has no default — omitting it fails validation. Allowed values: pue_invoice, ppd_invoice_and_complement, none. ## date Optional, in Unix epoch milliseconds (13 digits). Compared against Luxon.now().toMillis(); a future value returns 400. ## transfer_data — all-or-nothing transfer_data is optional, but when it is present all four of master, connect, master_to and connect_to are required; omitting any one fails validation. | field | type | constraint | |---|---|---| | master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) | | connect | string | required, non-empty — RFC of the connected team | | master_to | enum | required — client or connect | | connect_to | enum | required — client or master | | connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry | ## invoice_config All nested fields are optional: | field | type | meaning | |---|---|---| | serie | string | invoice series | | folio | number | invoice folio number | | date | number | invoice issue date, Unix epoch milliseconds | | global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 | | global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb | | global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly | | validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds | ## Email suppression ignore_emails: true suppresses notification emails. On this endpoint send_email is accepted but has no effect — only ignore_emails is persisted onto the payment. ## Unknown fields Body validation runs in strict allowlist mode — any undeclared key is rejected with 400 validation_failed / unexpected_key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"gigstack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gigstack.io/reference/createPaymentsRegister\">\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=Payments\u0026amp;title=Register+payment+%28you+were+already+paid%29\u0026amp;description=%5BSmall+working+example%5D%28%2Frecipes%2Fpayment%29%0A%0A**Integration+note%3A**+Records+money+already+received%3B+does+not+charge+a+card.+Repeating+a+creation+idempotency_key+re\u0026amp;theme=c8c9058b183856e8fedb0215\u0026amp;signature=1e7f67326ff52ea0ad6bb0270f45afbd10b6db76f5a1f71d5bdf5eedbbea06c4\">\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=\"Register payment (you were already paid) - gigstack\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Small working example Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished. Use this when you were already paid (cash, bank transfer, or any payment received outside gigstack): it records the payment as succeeded and runs its automations, such as issuing the invoice, right away. No payment link is created and nobody is charged. To ask a customer to pay you, use POST /payments/request instead. gigstack Connect: Register payments for other teams using the team parameter. ## Automation Types Control what happens automatically when registering a payment: - pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately - none: No automation, registers payment only ## PPD Invoice Linking You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field. When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method=\u0026#x27;PPD\u0026#x27; and status=\u0026#x27;valid\u0026#x27;. ## Payment Form The payment_form field specifies the Mexican SAT payment form code: Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc. The payment will be marked as \u0026#x27;succeeded\u0026#x27; immediately upon registration. ## Required fields client, currency, items (at least one), payment_form and automation_type are required. automation_type has no default — omitting it fails validation. Allowed values: pue_invoice, ppd_invoice_and_complement, none. ## date Optional, in Unix epoch milliseconds (13 digits). Compared against Luxon.now().toMillis(); a future value returns 400. ## transfer_data — all-or-nothing transfer_data is optional, but when it is present all four of master, connect, master_to and connect_to are required; omitting any one fails validation. | field | type | constraint | |---|---|---| | master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) | | connect | string | required, non-empty — RFC of the connected team | | master_to | enum | required — client or connect | | connect_to | enum | required — client or master | | connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry | ## invoice_config All nested fields are optional: | field | type | meaning | |---|---|---| | serie | string | invoice series | | folio | number | invoice folio number | | date | number | invoice issue date, Unix epoch milliseconds | | global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 | | global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb | | global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly | | validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds | ## Email suppression ignore_emails: true suppresses notification emails. On this endpoint send_email is accepted but has no effect — only ignore_emails is persisted onto the payment. ## Unknown fields Body validation runs in strict allowlist mode — any undeclared key is rejected with 400 validation_failed / unexpected_key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gigstack-736714cc.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Register+payment+%28you+were+already+paid%29\u0026amp;description=%5BSmall+working+example%5D%28%2Frecipes%2Fpayment%29%0A%0A**Integration+note%3A**+Records+money+already+received%3B+does+not+charge+a+card.+Repeating+a+creation+idempotency_key+re\u0026amp;theme=c8c9058b183856e8fedb0215\u0026amp;signature=1e7f67326ff52ea0ad6bb0270f45afbd10b6db76f5a1f71d5bdf5eedbbea06c4\">\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/createPaymentsRegister\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/createPaymentsRegister.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/createPaymentsRegister#webpage\",\"url\":\"https://docs.gigstack.io/reference/createPaymentsRegister\",\"name\":\"Register payment (you were already paid)\",\"description\":\"Small working example Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished. Use this when you were already paid (cash, bank transfer, or any payment received outside gigstack): it records the payment as succeeded and runs its automations, such as issuing the invoice, right away. No payment link is created and nobody is charged. To ask a customer to pay you, use POST /payments/request instead. gigstack Connect: Register payments for other teams using the team parameter. ## Automation Types Control what happens automatically when registering a payment: - pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately - none: No automation, registers payment only ## PPD Invoice Linking You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field. When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method='PPD' and status='valid'. ## Payment Form The payment_form field specifies the Mexican SAT payment form code: Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc. The payment will be marked as 'succeeded' immediately upon registration. ## Required fields client, currency, items (at least one), payment_form and automation_type are required. automation_type has no default — omitting it fails validation. Allowed values: pue_invoice, ppd_invoice_and_complement, none. ## date Optional, in Unix epoch milliseconds (13 digits). Compared against Luxon.now().toMillis(); a future value returns 400. ## transfer_data — all-or-nothing transfer_data is optional, but when it is present all four of master, connect, master_to and connect_to are required; omitting any one fails validation. | field | type | constraint | |---|---|---| | master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) | | connect | string | required, non-empty — RFC of the connected team | | master_to | enum | required — client or connect | | connect_to | enum | required — client or master | | connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry | ## invoice_config All nested fields are optional: | field | type | meaning | |---|---|---| | serie | string | invoice series | | folio | number | invoice folio number | | date | number | invoice issue date, Unix epoch milliseconds | | global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 | | global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb | | global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly | | validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds | ## Email suppression ignore_emails: true suppresses notification emails. On this endpoint send_email is accepted but has no effect — only ignore_emails is persisted onto the payment. ## Unknown fields Body validation runs in strict allowlist mode — any undeclared key is rejected with 400 validation_failed / unexpected_key.\",\"dateModified\":\"2026-11-05T23:43:47.376Z\",\"isPartOf\":{\"@id\":\"https://docs.gigstack.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gigstack.io/reference/createPaymentsRegister#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gigstack.io/reference/createPaymentsRegister#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core resources\",\"item\":\"https://docs.gigstack.io/reference/createClients\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.gigstack.io/reference/createPaymentsRequest\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Register payment (you were already paid)\",\"item\":\"https://docs.gigstack.io/reference/createPaymentsRegister\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gigstack.io/reference/createPaymentsRegister#apireference\",\"headline\":\"Register payment (you were already paid)\",\"name\":\"Register payment (you were already paid)\",\"description\":\"Small working example Integration note: Records money already received; does not charge a card. Repeating a creation idempotency_key returned HTTP 400 with error.code resource_conflict in staging. Reconcile the existing payment. ppd_invoice_id is a SAT UUID and enables complement automation even with automation_type none. Registration success is not proof that the asynchronous complement finished. Use this when you were already paid (cash, bank transfer, or any payment received outside gigstack): it records the payment as succeeded and runs its automations, such as issuing the invoice, right away. No payment link is created and nobody is charged. To ask a customer to pay you, use POST /payments/request instead. gigstack Connect: Register payments for other teams using the team parameter. ## Automation Types Control what happens automatically when registering a payment: - pue_invoice: Creates a PUE (Pago en Una sola Exhibición) invoice immediately - none: No automation, registers payment only ## PPD Invoice Linking You can link a payment to an existing PPD (Pago en Parcialidades o Diferido) invoice by providing the ppd_invoice_id field. When set, a payment complement (complemento de pago) CFDI will be automatically generated and linked to the PPD invoice. The referenced invoice must have payment_method='PPD' and status='valid'. ## Payment Form The payment_form field specifies the Mexican SAT payment form code: Common codes include: 01 (cash), 02 (check), 03 (electronic transfer), 04 (credit card), etc. The payment will be marked as 'succeeded' immediately upon registration. ## Required fields client, currency, items (at least one), payment_form and automation_type are required. automation_type has no default — omitting it fails validation. Allowed values: pue_invoice, ppd_invoice_and_complement, none. ## date Optional, in Unix epoch milliseconds (13 digits). Compared against Luxon.now().toMillis(); a future value returns 400. ## transfer_data — all-or-nothing transfer_data is optional, but when it is present all four of master, connect, master_to and connect_to are required; omitting any one fails validation. | field | type | constraint | |---|---|---| | master | number | required, 0 ≤ master ≤ 100 (percentage retained by the master team) | | connect | string | required, non-empty — RFC of the connected team | | master_to | enum | required — client or connect | | connect_to | enum | required — client or master | | connect_custom_config | object | optional; every field inside it is optional except type, rate and withholding on each taxes[] entry | ## invoice_config All nested fields are optional: | field | type | meaning | |---|---|---| | serie | string | invoice series | | folio | number | invoice folio number | | date | number | invoice issue date, Unix epoch milliseconds | | global.year | number | fiscal year of the global (EOM) invoice, e.g. 2026 | | global.months | string | SAT c_Meses code, e.g. 01 for January or 13 for Jan–Feb | | global.periodicity | string | SAT c_Periodicidad code — 01 daily, 02 weekly, 03 fortnightly, 04 monthly, 05 bimonthly | | validUntil | number | expiry of the self-invoicing window, Unix epoch milliseconds | ## Email suppression ignore_emails: true suppresses notification emails. On this endpoint send_email is accepted but has no effect — only ignore_emails is persisted onto the payment. ## Unknown fields Body validation runs in strict allowlist mode — any undeclared key is rejected with 400 validation_failed / unexpected_key.\",\"url\":\"https://docs.gigstack.io/reference/createPaymentsRegister\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gigstack.io/reference/createPaymentsRegister#webpage\"},\"dateModified\":\"2026-11-05T23:43:47.376Z\",\"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/createPaymentsRegister.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)","description":"Use this when **you want to get paid**: it creates a payment request, a payment in\n'requires_payment_method' status with a link your customer opens to pay. Nothing is\ncollected yet; any `automation_type` you set (for example an invoice) runs when the\ncustomer completes the payment. If you were **already paid**, use\n[`POST /payments/register`](/reference/createPaymentsRegister) instead.\n\n**gigstack Connect:** Create payment requests for other teams using the `team` parameter.\n\n## Payment Request Flow\n\nThis endpoint creates a payment request that customers can complete using various payment methods.\nThe payment will be created with status 'requires_payment_method'.\n\n## Allowed Payment Methods\n\n`allowed_payment_methods` is required. The validator accepts exactly these five values:\n\n- **`card`** — credit/debit card\n- **`bank`** — Mexican bank transfer (SPEI)\n- **`oxxo`** — OXXO convenience store\n- **`stripe-spei`** — Stripe customer balance\n- **`mercadopago-wallet`** — Mercado Pago wallet\n\nThe handler then narrows the list per processor and rejects anything outside the\nprocessor's own set:\n\n| `payment_processor` | accepted methods | currency |\n|---|---|---|\n| `stripe` (default) | `card`, `oxxo`, `bank`, `stripe-spei` | any |\n| `mercadopago` | `card`, `oxxo`, `mercadopago-wallet` | `MXN` only |\n| `openpay` | `card`, `bank_account`, `store` | `MXN` only |\n| `pagoralia` | `hosted`, `card`, `oxxo` | `MXN` only |\n| `conekta` | `hosted`, `card`, `oxxo`, `spei` | `MXN` only |\n\n> The processor-specific names in the right-hand column (`bank_account`, `store`,\n> `hosted`, `spei`) are **not** accepted by body validation — only the five enum values\n> above pass, so those processors are effectively limited to their overlap with the enum.\n\n## Required fields\n\n`client`, `currency`, `allowed_payment_methods`, `items` and **`automation_type`** are\nall required. `automation_type` has no default: omitting it fails validation with\n`missing_required`. Allowed values: `pue_invoice`, `ppd_invoice_and_complement`, `none`.\n\n## Email suppression\n\n`ignore_emails` takes precedence over `send_email`: the handler stores\n`ignore_emails ?? (send_email === false)`, so `ignore_emails: true` suppresses\nnotifications regardless of `send_email`.\n\n## Unknown fields\n\nBody validation runs in strict allowlist mode — any key not declared in the schema is\nrejected with `400 validation_failed` / `unexpected_key`.\n","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","description":"Accepts up to **10,000** payments in one request and registers them in the background. Each item is\nexactly the body of `POST /payments/register`, and must carry its own `idempotency_key`, unique within\nthe batch. To register more than 10,000 payments, send more batches, each with its own `Idempotency-Key`.\n\n**What happens in the request.** Every item is validated against the `POST /payments/register` body\nschema, with no I/O. An invalid item is listed in `rejected` with its reason and the rest go ahead;\nonly an empty or missing `payments` array, or more than 10,000 items, refuses the whole request (`400`).\nThe answer is `202` with the batch in `processing`; the first items may already have started.\n\n**What happens after.** Each accepted item is registered by the same code as `POST /payments/register`,\nwith the credential that created the batch, so it fails for the same reasons (a client or service that\ndoes not resolve, a date in the future, a currency with no exchange rate) and triggers the same\nautomations (`automation_type`, `ppd_invoice_id`). A temporary failure is retried automatically, up to\n6 attempts per item. Items run about 10 at a time per team, sharing the queue with the team's income\ninvoice batches, and a worker pauses about a second after each payment whose automation stamps an\ninvoice, so a large batch reaches proserver at a few stamps a second. Follow the batch with `GET /payments/register/batch/{id}`, or subscribe a webhook to\n`payment_batch.completed` (body `PaymentBatchCompletedWebhookEvent`, signed, sent once and never\nretried; see the `webhookEvent` callback of `POST /webhooks`), then read the per-item results with\n`GET /payments/register/batch/{id}/items`.\n\n**Two levels of idempotency.**\n- The `Idempotency-Key` header names the **batch**. The batch id is derived from your team, the\n credential's mode and the header, so the same key with the same body returns the same batch (`200`),\n and nothing is created again. The same key with a different body is `409` `idempotency_key_reused`.\n Bodies are compared as sent, including key order, so resend the exact same JSON.\n- Each item's `idempotency_key` names the **payment**. It is the same key `POST /payments/register`\n uses: a payment already registered under it, by an earlier batch or a single call, is not registered\n again, and the item ends `duplicate`. So a new batch that repeats items of a previous one is safe.\n\n**gigstack Connect:** create the batch for a connected team with the `team` parameter, and read it with the\nsame `team`.\n\n**Mode.** `livemode` comes only from the credential: a test key creates a test batch.\n\nNot supported here: split payments (`transfer_data`), which are rejected per item; register those one\nat a time with `POST /payments/register`.\n","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","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","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":"Register payment (you were already paid) - 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"]}