Invoice Series

Delete series

Soft-deletes an invoice series. If the series is active, it is automatically deactivated before deletion. The series code becomes available for reuse. **Restriction:** Cannot delete the default series. Assign another series as default first.

DELETE
/v1/configuration/series/{series_id}

Authorization

AuthorizationBearer <token>

API Key authentication.

Format: Authorization: Bearer beel_sk_<key>

Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with specific scopes that limit which endpoints it can access. The required scope for each endpoint is documented in the operation's security section under OAuth2.

Obtaining Keys: API Keys are managed from the BeeL dashboard

Security: API Keys are secret credentials. Do not share them or store them in source code

In: header

Path Parameters

series_idstring

Series ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.beel.es/api/v1/configuration/series/550e8400-e29b-41d4-a716-446655440000"
Empty
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The provided data is not valid",
    "details": {
      "field": "specific error message"
    }
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  },
  "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"
  }
}

Create invoice series POST

Creates a new invoice series. **Note:** The first series created by a user is automatically marked as default.

Get default series status per document type GET

Reports whether the user has a default invoice series for each `DocumentType` relevant to automatic invoicing flows (Stripe Connect, etc.). Used by integration setup screens to surface missing defaults at config time, preventing webhooks from being skipped at runtime with `failure.payment.skip.missing_default_series`. Environment is resolved via RLS from the request context — no input needed.