Skip to main content
PUT
Update draft invoice

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.

Path Parameters

id
string
required

Draft invoice ID

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

Same accepted fields as DraftInvoiceInput, all optional in validation. This does not imply PATCH semantics: omitted items become an empty array and other omitted fields receive mapper defaults. Send the complete intended body and read it back before stamping. Unknown top-level keys are still rejected (400 validation_failed / unexpected_key).

invoice_type
enum<string>
Available options:
I,
E
client
object | null
currency
string
exchange_rate
number
use
string
payment_form
enum<string>
Available options:
01,
02,
03,
04,
05,
06,
08,
12,
13,
14,
15,
17,
23,
24,
25,
26,
27,
28,
29,
30,
31,
99
payment_method
enum<string>
Available options:
PPD,
PUE
items
object[]
series
string
folio_number
number
exports
enum<string> | null
Available options:
01,
02,
03,
04,
null
complements
object[] | null
invoice_pdf_notes
string
addenda
string | null
global
object | null
automation_type
enum<string>
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

Response

Draft updated successfully

message
string
Example:

"Draft updated"

data
object