Invoices

Invoices

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/invoices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/invoices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/invoices")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "payment_status": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "ship_by_date": "2023-11-07T05:31:56Z",
      "approval_status": "<string>",
      "customer_po_number": "<string>",
      "payment_terms": "<string>",
      "public_note": "<string>",
      "private_note": "<string>",
      "total_qty": 123,
      "total_shipping": 123,
      "total_discount": 123,
      "total": 123,
      "total_paid": 123,
      "total_due": 123,
      "warehouse_id": 123,
      "ship_to": {
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>"
      },
      "quickbooks_invoice_id": "<string>",
      "quickbooks_message": "<string>",
      "customer": {
        "id": 123,
        "name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "items": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "sku": "<string>",
          "name": "<string>",
          "product_id": 123,
          "qty": 123,
          "unit_price": 123,
          "discount": 123,
          "total": 123
        }
      ],
      "payments": [
        {
          "id": 123,
          "invoice_id": 123,
          "gateway": "<string>",
          "type": "<string>",
          "charge_type": "<string>",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "external_id": "<string>",
          "notes": "<string>",
          "reference_id": "<string>",
          "gateway_response": {
            "status": "<string>",
            "code": "<string>",
            "message": "<string>",
            "metadata": "<string>"
          },
          "created_by": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "sales_order": {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "order_id": "<string>",
        "order_number": "<string>",
        "order_date": "2023-12-25",
        "payment_date": "2023-12-25",
        "ship_by_date": "2023-12-25",
        "age": 123,
        "order_status": "<string>",
        "customer_id": "<string>",
        "customer_username": "<string>",
        "customer_email": "<string>",
        "bill_to": {},
        "ship_to": {},
        "requested_shipping_service": "<string>",
        "total": 123,
        "total_paid": 123,
        "total_tax": 123,
        "total_shipping": 123,
        "customer_notes": "<string>",
        "internal_notes": "<string>",
        "ship_date": "2023-12-25",
        "hold_until_date": "2023-12-25",
        "user_id": 123,
        "externally_fulfilled": true,
        "externally_fulfilled_by": "<string>",
        "is_posted": true,
        "posted_by": "<string>",
        "not_sync": true,
        "sales_posted": true,
        "split_order": true,
        "skip_inventory": true,
        "skip_sales_report": true,
        "channel_id": 123,
        "total_order_cost": 123,
        "total_order_quantity": 123,
        "order_cost_details": {},
        "source": "<string>",
        "shipstation_order_id": "<string>",
        "type": "<string>",
        "parent_id": 123,
        "shipping_revenue": 123,
        "product_total": 123,
        "total_discount": 123,
        "picking_status": "<string>",
        "starred_description": "<string>",
        "customer_po_number": "<string>"
      },
      "custom_fields": {
        "Field Name 1": "Some Value"
      },
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "message": "<string>"
}

Invoices

Get a paginated list of invoices with optional filtering.

For detailed information about the filtering system and available operators, refer to the Filter System Documentation.

Available Filters

Integer Filters

company_id (alias customer_id): Company (customer) ID
sales_channel_id: Sales channel ID

String Filters

status: Invoice status
sales_order.order_number: Sales order number (if sales order attached)
payment_status: Payment status
approval_status: Approval status
customer_po_number: Customer PO number
tag: Invoice tags

Date Filters

order_date: Date the invoice was created
ship_by_date: Required ship by date
due_date: Date payment is due

DateTime Filters

created_at: When the invoice was created
updated_at: When the invoice was last updated

Numeric Filters

total_qty: Total quantity of items
total: Invoice total amount
total_shipping: Shipping cost
total_discount: Discount amount
total_paid: Amount paid
total_due: Amount still due

Custom Field Filters

custom_fields.{fieldName}: Filter by specific custom fields

Examples

# Find unpaid invoices over $500
?total[gt]=500.00&total_due[gt]=0

# Find invoices by a specific tag
?tag[eq]=Urgent

# Find completed invoices from last month
?status[eq]=completed&created_at[gte]=2024-11-01 00:00:00

# Find invoices with specific PO numbers
?customer_po_number[contains]=INV-123

# Find invoices by custom fields
?custom_fields.My Custom Field[eq]=Some value

# Find invoices where a specific custom field is empty
?custom_fields.My Custom Field[notset]

GET

invoices

Invoices

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/invoices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/invoices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/invoices")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "payment_status": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "ship_by_date": "2023-11-07T05:31:56Z",
      "approval_status": "<string>",
      "customer_po_number": "<string>",
      "payment_terms": "<string>",
      "public_note": "<string>",
      "private_note": "<string>",
      "total_qty": 123,
      "total_shipping": 123,
      "total_discount": 123,
      "total": 123,
      "total_paid": 123,
      "total_due": 123,
      "warehouse_id": 123,
      "ship_to": {
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>"
      },
      "quickbooks_invoice_id": "<string>",
      "quickbooks_message": "<string>",
      "customer": {
        "id": 123,
        "name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "items": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "sku": "<string>",
          "name": "<string>",
          "product_id": 123,
          "qty": 123,
          "unit_price": 123,
          "discount": 123,
          "total": 123
        }
      ],
      "payments": [
        {
          "id": 123,
          "invoice_id": 123,
          "gateway": "<string>",
          "type": "<string>",
          "charge_type": "<string>",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "external_id": "<string>",
          "notes": "<string>",
          "reference_id": "<string>",
          "gateway_response": {
            "status": "<string>",
            "code": "<string>",
            "message": "<string>",
            "metadata": "<string>"
          },
          "created_by": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "sales_order": {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "order_id": "<string>",
        "order_number": "<string>",
        "order_date": "2023-12-25",
        "payment_date": "2023-12-25",
        "ship_by_date": "2023-12-25",
        "age": 123,
        "order_status": "<string>",
        "customer_id": "<string>",
        "customer_username": "<string>",
        "customer_email": "<string>",
        "bill_to": {},
        "ship_to": {},
        "requested_shipping_service": "<string>",
        "total": 123,
        "total_paid": 123,
        "total_tax": 123,
        "total_shipping": 123,
        "customer_notes": "<string>",
        "internal_notes": "<string>",
        "ship_date": "2023-12-25",
        "hold_until_date": "2023-12-25",
        "user_id": 123,
        "externally_fulfilled": true,
        "externally_fulfilled_by": "<string>",
        "is_posted": true,
        "posted_by": "<string>",
        "not_sync": true,
        "sales_posted": true,
        "split_order": true,
        "skip_inventory": true,
        "skip_sales_report": true,
        "channel_id": 123,
        "total_order_cost": 123,
        "total_order_quantity": 123,
        "order_cost_details": {},
        "source": "<string>",
        "shipstation_order_id": "<string>",
        "type": "<string>",
        "parent_id": 123,
        "shipping_revenue": 123,
        "product_total": 123,
        "total_discount": 123,
        "picking_status": "<string>",
        "starred_description": "<string>",
        "customer_po_number": "<string>"
      },
      "custom_fields": {
        "Field Name 1": "Some Value"
      },
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page

integer

default:1

Page number for pagination

per_page

integer

default:10

Number of items per page (max 100)

Required range: x <= 100

fields

string

Comma-separated list of fields to include in each returned invoice (field projection). When omitted, the full invoice object is returned. Example: fields=id,status,total.

company_id

integer

Filter by the ID of the company (customer) the invoice belongs to

customer_id

integer

Alias for company_id — filter by the ID of the company (customer) the invoice belongs to

sales_channel_id

integer

Filter by the sales channel ID associated with the invoice

status

string

Filter by invoice status

sales_order.order_number

string

Filter by sales order number (if sales order is attached to invoice)

payment_status

string

Filter by payment status

approval_status

string

Filter by approval status

customer_po_number

string

Filter by customer PO number

tag

string

Filter by tag name

order_date

string<date>

Filter by order date (YYYY-MM-DD)

ship_by_date

string<date>

Filter by ship by date (YYYY-MM-DD)

due_date

string<date>

Filter by due date (YYYY-MM-DD)

created_at

string<date-time>

Filter by creation date (YYYY-MM-DD HH:mm:ss)

updated_at

string<date-time>

Filter by last update date (YYYY-MM-DD HH:mm:ss)

total_qty

number

Filter by total quantity

total

number

Filter by invoice total amount

total_shipping

number

Filter by shipping amount

total_discount

number

Filter by discount amount

total_paid

number

Filter by amount paid

total_due

number

Filter by amount due

custom_fields

object

Filter by custom fields

Response

Successful response

data

object[]

Show child attributes

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Available Filters

Integer Filters

String Filters

Date Filters

DateTime Filters

Numeric Filters

Custom Field Filters

Examples

Authorizations

Query Parameters

Response