Skip to main content
POST
Create draft invoice (pre-factura)

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

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) — body validation runs in strict allowlist mode. team, livemode and owner are reserved and injected by the auth middleware.

invoice_type
enum<string>
required

Type of invoice to draft:

  • I: Income (Ingreso)
  • E: Egress (Egreso / Credit Note)
Available options:
I,
E
Example:

"I"

client
object | null

Client information (optional at creation, required for stamping)

currency
string

Currency code (optional at creation, required for stamping)

Example:

"MXN"

exchange_rate
number

Exchange rate (auto-fetched if not provided at stamp time)

Example:

1

use
string

CFDI use code (optional at creation, required for stamping)

Example:

"G03"

payment_form
enum<string>

Payment form code (optional at creation, required for stamping)

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"

payment_method
enum<string>

Payment method (optional at creation, required for stamping)

Available options:
PPD,
PUE
Example:

"PUE"

items
object[]

Invoice line items (optional at creation, required for stamping)

series
string

Invoice series

Example:

"A"

folio_number
number

Custom folio number (auto-assigned if not provided at stamp time)

exports
enum<string> | null

Export classification

Available options:
01,
02,
03,
04,
null
complements
object[] | null
invoice_pdf_notes
string

Custom notes to include in the PDF

addenda
string | null

XML addenda to include

global
object | null
automation_type
enum<string>

Automation to trigger after stamping

Available options:
payment,
none
send_email
boolean

Whether to send the document via email to the client. Defaults to true.

ignore_emails
boolean | null

Suppress all notification emails for this document. Takes precedence over send_email — when true, no mail is sent even if send_email is true.

Example:

false

emails
string<email>[]
metadata
object

Custom key-value metadata

Response

Draft created successfully

message
string
Example:

"Draft created"

data
object