NewThree filters returned the wrong rows
BeeL
Get StartedMulti-NIFVeriFactuStripeAPI ReferenceChangelog
Invoice Series

Get default series status per document type

Scopeseries:read

Deprecated. Use GET /v1/companies/{company_id}/series/defaults, which behaves identically.

Reports, for each DocumentType used by automatic invoicing, whether there is a default invoice series and which one: exists, plus the series_id when there is one.

  • Why check it: a document type with no default series makes an incoming charge be skipped with failure.payment.skip.missing_default_series instead of invoiced.
  • Environment: test or production is resolved automatically from your request context; no input needed.
GET
/v1/configuration/series/defaults-status

Authorization

AuthorizationBearer <token>

Keys are prefixed beel_sk_, and each one carries the scopes it was created with: a key short of the scope an operation needs is answered 403. The scope an operation requires is shown next to its title, and the full catalogue lives in the Scopes reference.

Keys are created from the BeeL dashboard. They are secret credentials: do not share them or commit them to source control.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/configuration/series/defaults-status"
{
  "success": true,
  "data": {
    "defaults": [
      {
        "document_type": "UNASSIGNED",
        "exists": true,
        "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c",
        "code": "string",
        "provisional": true
      }
    ]
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required to access this resource"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Unsupported media type: text/plain. Supported: application/json"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Create default invoice series POST

**Deprecated.** Use `PUT /v1/companies/{company_id}/series/defaults`, which behaves identically. Ensuring a set of defaults is idempotent, so the canonical form is a `PUT`. Idempotently ensures the company (NIF) in focus has a default invoice series for each relevant `DocumentType` (`STANDARD`, `SIMPLIFIED`, `CORRECTIVE`) in the current environment. - **Already there:** a document type that already has a default keeps it, and it is returned unchanged. - **Missing:** a new series is created with code `F`, `S` or `R` and format `{CODIGO}-{YYYY}-{NUM:4}`, active and marked as default. - **Code taken:** if that code is already in use by a manually created series, the document type is skipped and omitted from the response.

Create invoice series POST

**Deprecated.** Use `POST /v1/companies/{company_id}/series`, which behaves identically. Creates a new invoice series for the company (NIF) in focus. - **Code:** must be unique within the company; a code already taken answers `409`. - **Numbering:** `format` must contain `{NUM}` or `{NUM:X}` and only accepts uppercase tokens. `counter_reset` defaults to `ANNUAL`, so a format with no year token has to be sent with `counter_reset: NEVER`. - **Default series:** the first series created for a document type is marked as default even if you send `default_series: false`.