Skip to main content
POST
Create bulk download request

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
start_date
string<date>
required

Start of date range (YYYY-MM-DD)

Example:

"2024-01-01"

end_date
string<date>
required

End of date range (YYYY-MM-DD)

Example:

"2024-01-31"

rfc_type
enum<string>
default:received

Direction of invoices to download (default: received)

Available options:
issued,
received
request_type
enum<string>
default:cfdi

Download XML files (cfdi) or metadata only (default: cfdi)

Available options:
cfdi,
metadata
invoice_type
enum<string>

Filter by CFDI type: I=income, E=expense, P=payment, N=payroll, T=transfer

Available options:
I,
E,
P,
N,
T
invoice_status
enum<string>

Filter by invoice status (default: all)

Available options:
active,
cancelled,
all
third_party_rfc
string

Filter by counterparty RFC

min_amount
string

Minimum invoice amount

max_amount
string

Maximum invoice amount

Response

Requests created, one per calendar month of the range. Already-pending months are reported in duplicates instead of being submitted again.

success
boolean
message
string
data
object