QR Invoice Scanner

Scan, manage, and export your invoices

QR App API Documentation

Integrate with our API to programmatically manage invoices and QR codes

Sign Up Log In

Getting Started

Follow these steps to start using the QR App API.

  1. Create an account - Sign up for a QR App account if you don't already have one.
  2. Generate an API key - Go to the API Keys section in your account settings and create a new API key.
  3. Make API requests - Use your API key to authenticate requests to our API endpoints.

Example Request

curl -X GET "https://qrapp.example.com/api/v1/invoices" \
  -H "X-API-Key: your_api_key_here"

Authentication

All API requests require authentication using an API key.

You can pass your API key in one of two ways:

1. HTTP Header (Recommended)

Include your API key in the X-API-Key header:

X-API-Key: your_api_key_here

2. Query Parameter

Include your API key as a query parameter:

https://qrapp.example.com/api/v1/invoices?api_key=your_api_key_here

Keep your API key secure and never share it publicly. You can revoke and regenerate API keys at any time from your account settings.

API Documentation

Learn how to use the QR App API to integrate with your applications.

Authentication

All API requests require authentication using an API key. You can pass your API key in one of two ways:

  • As a header: X-API-Key: your_api_key
  • As a query parameter: ?api_key=your_api_key

Endpoints

List Invoices

GET /api/v1/invoices

Returns a list of invoices for the authenticated user.

Query Parameters:
  • page - Page number (default: 1)
  • per_page - Items per page (default: 25)
  • invoice_number - Filter by invoice number
  • status - Filter by status
  • company_id - Filter by company ID
  • date_from - Filter by date range (YYYY-MM-DD)
  • date_to - Filter by date range (YYYY-MM-DD)
  • amount_min - Filter by minimum amount
  • amount_max - Filter by maximum amount
  • sort_by - Sort by field (invoice_number, invoice_date, invoice_amount, created_at)
  • sort_direction - Sort direction (asc, desc)

Get Invoice

GET /api/v1/invoices/:id

Returns details for a specific invoice.

Create Invoice

POST /api/v1/invoices

Creates a new invoice.

Request Body:
{
  "invoice": {
    "invoice_number": "INV-001",
    "invoice_date": "2025-03-09",
    "invoice_amount": 100.00,
    "invoice_status": "pending",
    "file_name": "invoice.pdf",
    "file_type": "pdf",
    "company_id": 1
  }
}

Update Invoice

PUT /api/v1/invoices/:id

Updates an existing invoice.

Delete Invoice

DELETE /api/v1/invoices/:id

Deletes an invoice.

Decode QR Code

POST /api/v1/qr_codes/decode

Decodes a QR code image and extracts invoice data.

Request Body:

Send as multipart/form-data with an image field containing the QR code image file.

Create QR Code

POST /api/v1/qr_codes

Creates a new QR code.

Request Body:
{
  "qr_code": {
    "name": "My QR Code",
    "url": "https://example.com",
    "description": "Description of the QR code",
    "company_id": 1,
    "active": true
  }
}

Response Format

All API responses are returned in JSON format. Successful responses will have a 2xx status code, while errors will have a 4xx or 5xx status code.

Example Success Response:
{
  "invoices": [
    {
      "id": 1,
      "invoice_number": "INV-001",
      "invoice_date": "2025-03-09",
      "invoice_amount": "100.0",
      "invoice_status": "pending",
      "created_at": "2025-03-09T12:00:00.000Z",
      "updated_at": "2025-03-09T12:00:00.000Z",
      "user": {
        "id": 1,
        "email": "[email protected]"
      }
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}
Example Error Response:
{
  "error": "Validation failed",
  "details": ["Invoice number can't be blank"]
}

Rate Limiting

API requests are limited to 100 requests per minute per API key. If you exceed this limit, you will receive a 429 Too Many Requests response.

Code Examples

Examples of how to use the QR App API in different programming languages.

JavaScript (Fetch API)

// List invoices
fetch('https://qrapp.example.com/api/v1/invoices', {
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

Python (Requests)

import requests

# List invoices
response = requests.get(
    'https://qrapp.example.com/api/v1/invoices',
    headers={'X-API-Key': 'your_api_key_here'}
)

print(response.json())

Ruby

require 'net/http'
require 'json'

# List invoices
uri = URI('https://qrapp.example.com/api/v1/invoices')
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)

PHP