SolidInvoice

https://solidinvoice.co/docs
Admin
SolidInvoice is an open-source invoicing solution for freelancers and small businesses that...
Tokens:25,728
Snippets:399
Trust Score:7.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run SolidInvoice Application

Source: https://solidinvoice.co/docs/installation-guide/homebrew

Execute this command to start the SolidInvoice application after installation. It will be accessible at https://localhost:8765.

```bash
solidinvoice run
```

--------------------------------

### Search Examples with Qualifiers

Source: https://solidinvoice.co/docs/using-solidinvoice/searching

These examples demonstrate combining multiple qualifiers to refine search results. They show how to filter by record type, status, client name, amount, and sorting preferences.

```text
in:invoices status:overdue sort:date_desc
```

```text
client:"Acme Corp" amount:5000
```

```text
in:clients,contacts john
```

--------------------------------

### Clone and Install SolidInvoice from Git

Source: https://solidinvoice.co/docs/installation-guide/git

Clone the SolidInvoice repository and install its dependencies using Composer and Bun. This is the first step for developers wanting to contribute or modify the source code.

```bash
git clone https://github.com/SolidInvoice/SolidInvoice.git  

cd SolidInvoice  

composer install  

bun install  

bun run build  
```

--------------------------------

### Make Binary Executable and Run

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Make the downloaded SolidInvoice binary executable and then start the application. This is the initial step for both Linux and macOS.

```bash
chmod +x solidinvoice  

./solidinvoice run  
```

--------------------------------

### Install SolidInvoice with Homebrew

Source: https://solidinvoice.co/docs/installation-guide/homebrew

Use this command to install SolidInvoice via the Homebrew package manager. This installs a self-contained build under a managed path.

```bash
brew install solidworx/tap/solidinvoice
```

--------------------------------

### Print Version

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Displays the currently installed version of SolidInvoice.

```bash
./solidinvoice version             # print the version  
```

--------------------------------

### Start Docker Compose Services

Source: https://solidinvoice.co/docs/installation-guide/docker

Brings up the services defined in the docker-compose.yml file in detached mode.

```bash
docker compose up -d  
```

--------------------------------

### Run with Self-Signed SSL (Default)

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Starts the application with HTTPS enabled using a self-signed certificate. Browsers will display a security warning that needs to be accepted.

```bash
./solidinvoice run  
```

--------------------------------

### Invoice Collection Example

Source: https://solidinvoice.co/docs/api/rest-api

Example of how to retrieve a paginated list of invoices, specifying the number of items per page.

```APIDOC
## GET /api/invoices

### Description
Retrieves a paginated collection of invoices.

### Method
GET

### Endpoint
/api/invoices

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **itemsPerPage** (integer) - Optional - The number of items to return per page. Defaults to 30.

### Request Example
```bash
curl -H "X-API-TOKEN: <your-token>" \
     "https://your-instance.example/api/invoices?page=2&itemsPerPage=50"
```

### Response
#### Success Response (200)
- **invoices** (array) - A list of invoice objects.
- **pagination** (object) - Pagination details.

#### Response Example
```json
{
  "invoices": [
    {
      "id": "inv_123",
      "client_id": "cli_456",
      "amount": 10000,
      "currency": "USD",
      "status": "paid",
      "created_at": "2023-10-27T10:00:00Z"
    }
  ],
  "pagination": {
    "currentPage": 2,
    "itemsPerPage": 50,
    "totalItems": 150,
    "totalPages": 3
  }
}
```
```

--------------------------------

### Run Local Web Server with Symfony CLI

Source: https://solidinvoice.co/docs/installation-guide/git

Start the local development web server using the Symfony CLI. This command reads the .symfony.local.yaml configuration file to set up the server and workers.

```bash
symfony serve  
```

--------------------------------

### Access API Documentation

Source: https://solidinvoice.co/docs/api/rest-api

Access the interactive Swagger UI for your installation to view the authoritative API reference. The documentation for the latest public release is also available online.

```bash
https://your-instance.example/api/docs
```

--------------------------------

### Run with Custom SSL Certificate

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Starts the application with HTTPS using a pre-existing custom SSL certificate and private key. This is useful for wildcard, EV, or corporate-issued certificates.

```bash
./solidinvoice run \
  --domain=invoice.example.com \
  --ssl-cert=/etc/ssl/solidinvoice.pem \
  --ssl-key=/etc/ssl/solidinvoice.key  
```

--------------------------------

### Enable Sentry in .env file

Source: https://solidinvoice.co/docs/integrations/sentry

For installations running from the distribution package or source, add the SOLIDINVOICE_SENTRY_DSN to your .env file to enable Sentry.

```dotenv
SOLIDINVOICE_SENTRY_DSN=https://<key>@o0.ingest.sentry.io/<project-id>  
```

--------------------------------

### Run SolidInvoice with Docker

Source: https://solidinvoice.co/docs/installation-guide/docker

Starts SolidInvoice in detached mode, mapping host port 8765 to container port 8765 and mounting a volume for data persistence.

```bash
docker run -d -p 8765:8765 -v solidinvoice_data:/etc/solidinvoice solidinvoice/solidinvoice  
```

--------------------------------

### systemd Service Management Commands

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Reload systemd, enable, and start the SolidInvoice worker service. Use these commands after creating or modifying the service unit file.

```bash
sudo systemctl daemon-reload

sudo systemctl enable --now solidinvoice-worker.service
```

--------------------------------

### Run with Let's Encrypt SSL

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Starts the application with HTTPS enabled, automatically issuing and renewing a free SSL certificate from Let's Encrypt. Requires the domain's DNS to point to the server's IP and ports 80/443 to be accessible.

```bash
./solidinvoice run --domain=invoice.example.com --lets-encrypt  
```

--------------------------------

### Cron Job Setup for Shared Hosting

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Set up a cron job to run the SolidInvoice worker. This is a fallback for environments where long-running services are not permitted. The `--time-limit=55` flag ensures the worker terminates before the next cron execution, preventing overlap. Note that this can introduce delays in message processing.

```crontab
* * * * * /usr/bin/php /opt/solidinvoice/bin/console messenger:consume --all --limit=10 --time-limit=55 --memory-limit=128M
```

--------------------------------

### Symfony Local Server Configuration

Source: https://solidinvoice.co/docs/installation-guide/git

Example configuration for the Symfony local web server and workers, defined in the .symfony.local.yaml file. It specifies document root, port, and worker commands.

```yaml
http:
    document_root: public/
    passthru: index.php
    port: 7005
    preferred_port: 7005
    allow_http: true
    daemon: true

workers:
    messenger_consume:
        cmd: ['symfony', 'console', 'messenger:consume', 'async', '--time-limit=3600', '--memory-limit=128M']
        watch: ['config', 'src']

```

--------------------------------

### Run Behind a Reverse Proxy

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Starts the application serving plain HTTP, intended for use when an upstream proxy (like Cloudflare or Nginx) handles TLS termination. The server trusts X-Forwarded-* headers from the proxy.

```bash
./solidinvoice run --disable-https  
```

--------------------------------

### Supervisord Management Commands

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Reload Supervisord configuration, update processes, and start the SolidInvoice worker. These commands are used after configuring the worker in Supervisord.

```bash
sudo supervisorctl reread

sudo supervisorctl update

sudo supervisorctl start solidinvoice-worker:*
```

--------------------------------

### Docker Compose for SolidInvoice Stack

Source: https://solidinvoice.co/docs/installation-guide/docker

Defines a Docker Compose setup for SolidInvoice, including a MySQL database and the SolidInvoice application. This configuration ensures data persistence for both the database and application.

```yaml
services:
  db:
    image: "mysql:8.0"
    volumes:
      - db_data:/var/lib/mysql
    restart: always
    environment:
      MYSQL_DATABASE: solidinvoice
      MYSQL_ALLOW_EMPTY_PASSWORD: 1
  app:
    image: "solidinvoice/solidinvoice:latest"
    depends_on:
      - db
    ports:
      - "8765:8765"
    restart: always
    volumes:
      - app_data:/etc/solidinvoice

volumes:
  db_data: {}
  app_data: {}  
```

--------------------------------

### Resource CRUD Operations

Source: https://solidinvoice.co/docs/api/rest-api

All main resources support standard CRUD operations: GET for collections and items, POST to create, PATCH to update, and DELETE to remove.

```APIDOC
## General Resource Operations

### Description
Standard CRUD operations are supported for most resources.

### Methods
- **GET**: Retrieve collections or individual items.
- **POST**: Create a new resource.
- **PATCH**: Partially update an existing resource.
- **DELETE**: Remove a resource.

### Example Endpoints
- `/api/invoices` (Collection)
- `/api/invoices/{id}` (Item)
- `/api/clients` (Collection)
- `/api/clients/{id}` (Item)

### Note on Amounts
Monetary amounts are expressed in minor currency units (e.g., cents for USD). The currency is determined by the associated client.
```

--------------------------------

### systemd Service Unit Configuration

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Configure a systemd service for the SolidInvoice worker. This is recommended for Linux servers for reliable long-running processes. Ensure the User, WorkingDirectory, and ExecStart paths are correct for your installation.

```systemd
[Unit]

Description=SolidInvoice worker

After=network.target

[Service]

Type=simple

User=www-data

WorkingDirectory=/opt/solidinvoice

ExecStart=/usr/bin/php bin/console messenger:consume --all --time-limit=3600 --memory-limit=128M

Restart=on-failure

RestartSec=5

[Install]

WantedBy=multi-user.target
```

--------------------------------

### Print Build Information

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Shows detailed build information for the SolidInvoice application.

```bash
./solidinvoice build-info          # print build details  
```

--------------------------------

### Run Database Migrations

Source: https://solidinvoice.co/docs/ai/mcp-server

Execute this command to create the required OAuth and token tables in your database for the MCP server.

```bash
bin/console doctrine:migrations:migrate
```

--------------------------------

### Filter Invoices by Status

Source: https://solidinvoice.co/docs/api/graphql

Apply filters directly to collection queries. This example filters invoices to show only those with a 'pending' status.

```graphql
query {
  invoices(status: "pending") {
    edges {
      node {
        id
        status
        total
      }
    }
  }
}
```

--------------------------------

### SolidInvoice OAuth Check URL

Source: https://solidinvoice.co/docs/integrations/google-oauth

This is the URL that Google will redirect to after user authorization. Ensure this matches your SolidInvoice installation's domain and path.

```text
https://your-solidinvoice-domain.example/oauth/check/google
```

--------------------------------

### Filter Clients by Name

Source: https://solidinvoice.co/docs/api/graphql

Filter collections by providing relevant arguments to the query. This example retrieves clients whose names contain 'Acme'.

```graphql
query {
  clients(name: "Acme") {
    edges {
      node {
        id
        name
      }
    }
  }
}
```

--------------------------------

### Configure Apache Webserver

Source: https://solidinvoice.co/docs/installation-guide/distribution-package

Apache VirtualHost configuration to serve SolidInvoice from the \/opt\/solidinvoice\/public directory. Ensure \"AllowOverride All\" is set for .htaccess rewrites and adjust log paths as needed.

```apache
<VirtualHost *:80>
    ServerName yourdomain.com
    ServerAlias www.yourdomain.com

    DocumentRoot /opt/solidinvoice/public
    <Directory /opt/solidinvoice/public>
        # enable the .htaccess rewrites
        AllowOverride All
        Require all granted
    </Directory>

    ErrorLog /var/log/apache2/solidinvoice.error.log
    CustomLog /var/log/apache2/solidinvoice.access.log combined
</VirtualHost>
```

--------------------------------

### GraphQL Endpoint

Source: https://solidinvoice.co/docs/api/graphql

The GraphQL endpoint is available at /api/graphql on your SolidInvoice installation. Use the hosted endpoint for the hosted plan or replace the domain with your own for self-hosted instances.

```APIDOC
## GraphQL Endpoint

The GraphQL endpoint is available at `/api/graphql` on your SolidInvoice installation.

**Hosted Plan:**
```
https://solidinvoice.app/api/graphql
```

**Self-Hosted Instance:**
```
https://your-domain.example/api/graphql
```
```

--------------------------------

### Create Meilisearch Indexes

Source: https://solidinvoice.co/docs/integrations/meilisearch

Run this command to create the necessary indexes in your Meilisearch instance based on the configured settings.

```bash
bin/console meilisearch:create
```

--------------------------------

### Plesk Scheduled Task Command

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Configure a scheduled task in Plesk to run the SolidInvoice worker. Verify the command path matches your SolidInvoice installation directory.

```bash
/usr/bin/php /path/to/solidinvoice/bin/console messenger:consume --all --limit=10 --time-limit=55 --memory-limit=128M
```

--------------------------------

### Configure Nginx Webserver

Source: https://solidinvoice.co/docs/installation-guide/distribution-package

Nginx configuration to serve SolidInvoice from the \/opt\/solidinvoice\/public directory. Ensure the PHP-FPM socket path and log directories are adjusted for your environment.

```nginx
server {
  server_name yourdomain.com www.yourdomain.com;
  root /opt/solidinvoice/public;

  location / {
    # try to serve file directly, fallback to index.php
    try_files $uri /index.php$is_args$args;
  }

  location ~ ^/index\.php(/|$) {
    fastcgi_pass unix:/var/run/php-fpm.sock;
    fastcgi_split_path_info ^(.+\.php)(/.*);
    include fastcgi_params;
    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
    fastcgi_param HTTPS off;
  }

  error_log /var/log/nginx/solidinvoice_error.log;
  access_log /var/log/nginx/solidinvoice_access.log;
}
```

--------------------------------

### Run Dedicated Messenger Worker

Source: https://solidinvoice.co/docs/installation-guide/quick-install

Starts a dedicated messenger worker process, which can be useful for managing background asynchronous tasks, especially in environments like Kubernetes.

```bash
./solidinvoice worker --workers=2  # dedicated messenger worker process (e.g. for Kubernetes)  
```

--------------------------------

### Import Data into Meilisearch

Source: https://solidinvoice.co/docs/integrations/meilisearch

Populate your Meilisearch indexes with existing data from the SolidInvoice database. This command iterates through all searchable entities.

```bash
bin/console meilisearch:import
```

--------------------------------

### Create a Client Resource

Source: https://solidinvoice.co/docs/api/graphql

Mutations for creating resources require an 'input' argument containing the resource's fields. The mutation returns the created resource.

```graphql
mutation {
  createClient(input: {
    name: "Acme Corp"
    currency: "USD"
    website: "https://acme.example"
  }) {
    client {
      id
      name
    }
  }
}
```

--------------------------------

### cPanel Cron Job Command

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Configure a cron job within cPanel to run the SolidInvoice worker. Ensure the command path correctly points to your SolidInvoice installation.

```bash
/usr/bin/php /home/yourusername/path/to/solidinvoice/bin/console messenger:consume --all --limit=10 --time-limit=55 --memory-limit=128M
```

--------------------------------

### Configure MCP Server in Codex Config

Source: https://solidinvoice.co/docs/ai/mcp-server

Add the SolidInvoice MCP server configuration to the `~/.codex/config.toml` file. This allows Codex to connect to your SolidInvoice instance.

```toml
[mcp_servers.solidinvoice]
url = "https://solidinvoice.app/_mcp"
```

--------------------------------

### GraphQL Mutation Validation Error Example

Source: https://solidinvoice.co/docs/api/graphql

When a mutation fails due to validation errors, the response includes an 'errors' array. Each error details the message and specific field violations.

```json
{
  "errors": [{
    "message": "name: This value should not be blank.",
    "extensions": {
      "violations": [
        { "path": "name", "message": "This value should not be blank." }
      ]
    }
  }]
}
```

--------------------------------

### Fetching Related Data

Source: https://solidinvoice.co/docs/api/graphql

Request related resources in a single GraphQL query to avoid multiple requests. This example fetches invoices along with their client and line item details.

```APIDOC
## Fetching related data

One of GraphQL's key advantages is requesting related resources in a single round-trip. The following query fetches invoices together with their client name and line items in one request:

### GraphQL Query
```graphql
query {
  invoices {
    edges {
      node {
        id
        status
        total
        client {
          name
          currency
        }
        lines {
          edges {
            node {
              description
              qty
              price
            }
          }
        }
      }
    }
  }
}
```
```

--------------------------------

### Generate OAuth Signing Keys

Source: https://solidinvoice.co/docs/ai/mcp-server

Run this command once to generate the necessary OAuth signing keys for the MCP server. Keys are stored in the SolidInvoice configuration directory and persist across redeployments.

```bash
bin/console mcp:keys:generate
```

--------------------------------

### Import Data with Custom Batch Size and Timeout

Source: https://solidinvoice.co/docs/integrations/meilisearch

For large datasets, tune the batch size and request timeout to optimize the import process. Adjust these values based on your server's performance and network conditions.

```bash
bin/console meilisearch:import --batch-size=500 --response-timeout=10000
```

--------------------------------

### Clear Cache and Migrate Database

Source: https://solidinvoice.co/docs/installation-guide/distribution-package

After replacing project files, clear the production cache and apply database migrations. Ensure you are in the production environment.

```bash
bin/console cache:clear --env=prod
```

```bash
bin/console doctrine:migrations:migrate --env=prod --no-interaction
```

--------------------------------

### Add MCP Server with User Scope via CLI

Source: https://solidinvoice.co/docs/ai/mcp-server

Add the SolidInvoice MCP server with the `--scope user` flag to make the connection available across all projects. This ensures broader access for the agent.

```bash
claude mcp add --scope user --transport http solidinvoice https://solidinvoice.app/_mcp
```

--------------------------------

### Configure SolidInvoice with Docker

Source: https://solidinvoice.co/docs/integrations/google-oauth

Set the Google OAuth client ID and secret as environment variables when running SolidInvoice via Docker. Both variables must be set for the integration to activate.

```bash
docker run \
  -e SOLIDINVOICE_OAUTH_CLIENT_GOOGLE_CLIENT_ID=... \
  -e SOLIDINVOICE_OAUTH_CLIENT_GOOGLE_CLIENT_SECRET=... \
  solidinvoice/solidinvoice
```

--------------------------------

### Run SolidInvoice Background Worker

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

This command starts the SolidInvoice background worker for processing asynchronous messages and scheduled tasks. Ensure this command runs continuously to enable features like email sending and recurring invoice generation. This is typically set up via a cron job.

```bash
bin/console messenger:consume --all --time-limit=3600 --memory-limit=128M
```

--------------------------------

### Enable Performance Tracing

Source: https://solidinvoice.co/docs/integrations/sentry

To enable performance tracing, set the SOLIDINVOICE_SENTRY_TRACES_SAMPLE_RATE environment variable to a value between 0.0 and 1.0. A value of 1.0 captures all requests.

```dotenv
SOLIDINVOICE_SENTRY_TRACES_SAMPLE_RATE=0.1  
```

--------------------------------

### Connect MCP Inspector

Source: https://solidinvoice.co/docs/ai/mcp-server

Use the MCP Inspector tool to quickly test a connection to the SolidInvoice MCP server without full agent configuration. This command initiates dynamic client registration and OAuth flow.

```bash
npx @modelcontextprotocol/inspector https://solidinvoice.app/_mcp
```

--------------------------------

### Enable Profiling

Source: https://solidinvoice.co/docs/integrations/sentry

To enable profiling, set both SOLIDINVOICE_SENTRY_TRACES_SAMPLE_RATE and SOLIDINVOICE_SENTRY_PROFILES_SAMPLE_RATE environment variables. The profile sample rate is relative to the trace sample rate.

```dotenv
SOLIDINVOICE_SENTRY_TRACES_SAMPLE_RATE=0.1  

SOLIDINVOICE_SENTRY_PROFILES_SAMPLE_RATE=1.0  
```

--------------------------------

### Update SolidInvoice with Homebrew

Source: https://solidinvoice.co/docs/installation-guide/homebrew

Run this command to upgrade SolidInvoice to the latest version using Homebrew. This ensures you have the most recent features and fixes.

```bash
brew upgrade solidworx/tap/solidinvoice
```

--------------------------------

### Configure Meilisearch Environment Variables

Source: https://solidinvoice.co/docs/integrations/meilisearch

Set these environment variables to enable and configure the Meilisearch integration. Restart the application after changing these values. The search bar only appears if both URL and API key are set.

```env
SOLIDINVOICE_MEILISEARCH_URL=http://meilisearch.internal:7700

SOLIDINVOICE_MEILISEARCH_API_KEY=your-meilisearch-api-key

SOLIDINVOICE_MEILISEARCH_PREFIX=solidinvoice_prod_
```

--------------------------------

### Configure SolidInvoice with .env file

Source: https://solidinvoice.co/docs/integrations/google-oauth

Add the Google OAuth client ID and secret to the .env file at the root of your SolidInvoice application. These variables are required for the integration to function.

```env
SOLIDINVOICE_OAUTH_CLIENT_GOOGLE_CLIENT_ID=1234567890-abcdef.apps.googleusercontent.com
SOLIDINVOICE_OAUTH_CLIENT_GOOGLE_CLIENT_SECRET=GOCSPX-your-client-secret
```

--------------------------------

### Add MCP Server via CLI

Source: https://solidinvoice.co/docs/ai/mcp-server

Add the SolidInvoice MCP server using the `claude mcp add` command. The `--transport http` flag specifies the communication protocol.

```bash
claude mcp add --transport http solidinvoice https://solidinvoice.app/_mcp
```

--------------------------------

### Add Claude MCP Connector

Source: https://solidinvoice.co/docs/ai/mcp-server

Connect to the SolidInvoice MCP server using Claude Desktop. This requires specifying a name and the MCP server URL.

```text
Name : `SolidInvoice`
URL : `https://solidinvoice.app/_mcp` (or your self-hosted URL)
```

--------------------------------

### Re-index with Zero Downtime

Source: https://solidinvoice.co/docs/integrations/meilisearch

Use the `--swap-indices` option for zero-downtime re-indexing on a live system. Meilisearch imports into temporary indexes and atomically swaps them upon completion, ensuring users always see complete results.

```bash
bin/console meilisearch:import --swap-indices
```

--------------------------------

### Download SolidInvoice Archive

Source: https://solidinvoice.co/docs/installation-guide/distribution-package

Use curl to download the latest SolidInvoice archive in either zip or tar.gz format from the official download server.

```bash
curl -LO https://download.solidworx.co/solidinvoice/latest/archive/zip
```

```bash
curl -LO https://download.solidworx.co/solidinvoice/latest/archive/tar.gz
```

--------------------------------

### Configure MCP Session Store for Multi-Node Deployments

Source: https://solidinvoice.co/docs/ai/mcp-server

For multi-node deployments, set the MCP session store to 'cache' and specify a cache pool (e.g., Redis) to ensure sessions persist across different nodes. This is configured in the .env.local file.

```dotenv
SOLIDINVOICE_MCP_SESSION_STORE=cache

SOLIDINVOICE_MCP_SESSION_CACHE_POOL=cache.app
```

--------------------------------

### Supervisord Program Configuration

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Configure a Supervisord program for the SolidInvoice worker. This is suitable for systems without systemd or when managing services with Supervisord. Adjust paths and resource limits as needed. `stopwaitsecs` should be higher than your slowest expected message processing time.

```ini
[program:solidinvoice-worker]

command=/usr/bin/php /opt/solidinvoice/bin/console messenger:consume --all --time-limit=3600 --memory-limit=128M

user=www-data

numprocs=1

process_name=%(program_name)s_%(process_num)02d

autostart=true

autorestart=true

startsecs=5

startretries=10

stopasgroup=true

killasgroup=true

stopwaitsecs=30

stdout_logfile=/var/log/supervisor/solidinvoice-worker.log

stderr_logfile=/var/log/supervisor/solidinvoice-worker.err.log
```

--------------------------------

### Fetching a Collection

Source: https://solidinvoice.co/docs/api/graphql

Fetch a list of resources by using the plural resource name in your query. Collections return a Relay-style connection with an 'edges' wrapper.

```APIDOC
## Fetching a collection

Use the plural resource name to fetch a list. Each collection returns a Relay-style connection with an `edges` wrapper:

### GraphQL Query
```graphql
query {
  invoices {
    edges {
      node {
        id
        status
        total
      }
    }
  }
}
```

### cURL Example
```bash
curl -X POST https://solidinvoice.app/api/graphql \
     -H "X-API-TOKEN: <your-token>" \
     -H "Content-Type: application/json" \
     -d '{ \
       "query": "{ invoices { edges { node { id status total } } } }" \
     }'
```
```

--------------------------------

### Configure MCP Server in VS Code Settings

Source: https://solidinvoice.co/docs/ai/mcp-server

Configure the SolidInvoice MCP server within VS Code's settings. This involves adding a JSON object to the MCP settings, specifying the server name and URL.

```json
{
  "mcpServers": {
    "solidinvoice": {
      "url": "https://solidinvoice.app/_mcp"
    }
  }
}
```

--------------------------------

### Enable Sentry with Docker

Source: https://solidinvoice.co/docs/integrations/sentry

To enable Sentry when running SolidInvoice via Docker, pass the Sentry DSN as an environment variable during the container run.

```bash
docker run -e SOLIDINVOICE_SENTRY_DSN=https://<key>@o0.ingest.sentry.io/<project-id> solidinvoice/solidinvoice  
```

--------------------------------

### Windows Task Scheduler Arguments

Source: https://solidinvoice.co/docs/installation-guide/distribution-package/cron-job-setup

Configure the arguments for a Windows Task Scheduler job to run the SolidInvoice worker. Ensure the path to `php.exe` and the console script are correct for your Windows environment.

```powershell
C:\path\to\solidinvoice\bin\console messenger:consume --all --limit=10 --time-limit=55 --memory-limit=128M
```
Tokens:
Raw