curl -X GET "https://api.nevatal.com/api/v1/billing/invoices/pdf-export/form-schema" \
-H "Authorization: Bearer nvtl_your_api_key"
{
"success": true,
"data": {
"invoiceTypeOptions": [
{ "value": "all", "label": "All" },
{ "value": "electronic", "label": "Electronic" },
{ "value": "manual", "label": "Manual" }
],
"defaultInvoiceType": "all",
"defaultFrom": "2026-09-01",
"defaultTo": "2026-09-15",
"maxInvoices": 100,
"helpText": "Downloads a ZIP with the PDF of every invoice issued in the range (payer accounts and voided invoices included) plus a CSV manifest. At most 100 invoices per download."
}
}
Billing
Get Invoice PDF Export Form Schema
Backend-driven options, defaults and cap for the invoice PDF export dialog
GET
/
api
/
v1
/
billing
/
invoices
/
pdf-export
/
form-schema
curl -X GET "https://api.nevatal.com/api/v1/billing/invoices/pdf-export/form-schema" \
-H "Authorization: Bearer nvtl_your_api_key"
{
"success": true,
"data": {
"invoiceTypeOptions": [
{ "value": "all", "label": "All" },
{ "value": "electronic", "label": "Electronic" },
{ "value": "manual", "label": "Manual" }
],
"defaultInvoiceType": "all",
"defaultFrom": "2026-09-01",
"defaultTo": "2026-09-15",
"maxInvoices": 100,
"helpText": "Downloads a ZIP with the PDF of every invoice issued in the range (payer accounts and voided invoices included) plus a CSV manifest. At most 100 invoices per download."
}
}
Backend-driven descriptor for the Export Invoice PDFs
dialog: the type options, the default date range and the invoice cap all come
from here — the frontend never hardcodes them.
Response
array
Always the three options, in order:
all, electronic, manual. Each is
{ value, label } with a pre-localized label.string
allstring
YYYY-MM-DD — first day of the current monthstring
YYYY-MM-DD — todayinteger
Maximum invoices allowed in one export (currently
100)string
Pre-localized help text describing what the export includes
Errors
| Status | When |
|---|---|
401 | Missing or invalid token |
403 | Caller lacks BILLING:read |
curl -X GET "https://api.nevatal.com/api/v1/billing/invoices/pdf-export/form-schema" \
-H "Authorization: Bearer nvtl_your_api_key"
{
"success": true,
"data": {
"invoiceTypeOptions": [
{ "value": "all", "label": "All" },
{ "value": "electronic", "label": "Electronic" },
{ "value": "manual", "label": "Manual" }
],
"defaultInvoiceType": "all",
"defaultFrom": "2026-09-01",
"defaultTo": "2026-09-15",
"maxInvoices": 100,
"helpText": "Downloads a ZIP with the PDF of every invoice issued in the range (payer accounts and voided invoices included) plus a CSV manifest. At most 100 invoices per download."
}
}