Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Overview

The "Create Invoice" operation in the Lectful Central node allows users to create a new invoice associated with a specific subscription. This is useful for automating billing workflows, generating invoices programmatically, and integrating invoicing into broader business processes.

Typical use cases include:

  • Automatically generating invoices when a new subscription is created or updated.
  • Creating invoices with custom invoice numbers, amounts, due dates, and statuses.
  • Integrating with accounting or ERP systems to synchronize invoice data.

For example, you might use this node to create an invoice for a subscription renewal, specifying the amount due, currency, and due date, and setting the invoice status to "sent" to indicate it has been issued to the customer.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful Central API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Base URL Override Optional base URL to override the credential setting (used only in Manual Configuration mode). Exclude /api/v1.
API Key Override Optional API key to override the credential setting (used only in Manual Configuration mode).
Subscription ID ID of the subscription to invoice (required).
Invoice Number Unique invoice number identifier (e.g., INV-001) (required).
Amount Invoice amount (required).
Currency Currency code for the invoice amount (e.g., USD, EUR) (default: USD) (required).
Due Date Due date for the invoice in YYYY-MM-DD format (required).
Status Invoice status; options are: Draft, Sent, Paid, Overdue, Cancelled (default: Sent) (required).
Description Optional description text for the invoice.

Output

The node outputs JSON data representing the response from the Lectful Central API after creating the invoice. The JSON structure typically includes details of the newly created invoice such as its ID, subscription association, invoice number, amount, currency, due date, status, description, timestamps, and other metadata returned by the API.

No binary data output is produced by this operation.

Example output JSON snippet (conceptual):

{
  "id": 123,
  "subscription_id": 456,
  "invoice_number": "INV-001",
  "amount": 100.00,
  "currency": "USD",
  "due_date": "2024-07-01",
  "status": "sent",
  "description": "Monthly subscription invoice",
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

Dependencies

  • Requires access to the Lectful Central API.
  • Authentication can be provided either via stored credentials configured in n8n or manual entry of the base URL and API key.
  • The API key must have permissions to create invoices.
  • Network connectivity to the Lectful Central API endpoint is necessary.

Troubleshooting

  • Missing or invalid credentials: If using stored credentials, ensure they are correctly configured with a valid base URL and API key. For manual mode, both Base URL Override and API Key Override must be provided.
  • Invalid input parameters: Required fields like Subscription ID, Invoice Number, Amount, Currency, Due Date, and Status must be provided and valid. For example, the due date must follow the YYYY-MM-DD format.
  • API errors: The API may return errors if the subscription ID does not exist, the invoice number is not unique, or the amount is invalid. Check the error message returned in the node output for details.
  • Network issues: Ensure that the n8n instance can reach the Lectful Central API endpoint without firewall or DNS issues.

Links and References


This summary is based on static analysis of the node's source code and property definitions related to the "Invoice Management" resource and "Create Invoice" operation.

Discussion