CompanySeries
List the invoice series of a company
Returns the invoice series of a company.
- Filters: active restricts to active or inactive series — omit it and you get all of them. document_type returns the series of that type, the only ones that can number it.
- Pagination (opt-in): send page and/or limit to receive a single page plus a data.pagination block with the totals. Omit both and the response carries the full list in data.series and no pagination block.
get/v1/companies/{company_id}/series
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/series
- Auth: HTTP bearer
Query parameters
activeboolean
Filters by activity: true returns only active series, false only inactive ones. Omit it and you get all the series, active and inactive.
document_type'UNASSIGNED' | 'STANDARD' | 'SIMPLIFIED' | 'CORRECTIVE' | 'SIMPLIFIED_CORRECTIVE' | 'PROFORMA'
Document type associated with a series. Values mirror InvoiceType, so the series a document needs is named exactly like the document:
- UNASSIGNED: Legacy value of series created before types existed. A series numbers only documents of its own type, so an UNASSIGNED series numbers none (422 SERIES_INCOMPATIBLE_DOC_TYPE); give it a type to keep using it. No series can be created with it or moved to it (422 SERIES_UNASSIGNED_TYPE_NOT_ALLOWED). The live ones were given the type they numbered most.
- STANDARD: Standard invoice
- SIMPLIFIED: Simplified invoice
- CORRECTIVE: Corrects or cancels a previous standard invoice (R1–R4)
- SIMPLIFIED_CORRECTIVE: Corrects a simplified invoice (R5). Spanish law requires R5 to be numbered apart from R1–R4, so they have a series type of their own
- PROFORMA: Proforma (commercial document, non-fiscal numbering)
Filter by document type
pageinteger
Page number (starts at 1). Omit for the full, unpaginated list.
limitinteger
Items per page. Omit for the full, unpaginated list.
Response
Series retrieved successfully
Example response
{
"success": true,
"data": {
"series": [
{
"name": "Main Series",
"code": "FAC",
"description": "Series for standard invoices",
"format": "{CODIGO}-{YYYY}-{NUM:4}",
"initial_number": 1
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 87,
"items_per_page": 20
}
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.