List invoices

cURL

curl --request GET \
  --url https://api.uselotus.io/api/invoices/ \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.uselotus.io/api/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://api.uselotus.io/api/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: <api-key>"
  ],
]);

$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://api.uselotus.io/api/invoices/"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.uselotus.io/api/invoices/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "invoice_id": "<string>",
    "invoice_number": "<string>",
    "cost_due": 5000000000,
    "amount": 0,
    "currency": {
      "code": "<string>",
      "name": "<string>",
      "symbol": "<string>"
    },
    "issue_date": "2023-11-07T05:31:56Z",
    "payment_status": "draft",
    "external_payment_obj_id": "<string>",
    "external_payment_obj_type": "stripe",
    "line_items": [
      {
        "name": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "quantity": 5000000000,
        "billing_type": "in_arrears",
        "metadata": {},
        "plan": {
          "plan_name": "<string>",
          "plan_id": "<string>",
          "version_id": "<string>",
          "version": 123
        },
        "subscription_filters": [
          {
            "value": "<string>",
            "property_name": "<string>"
          }
        ],
        "base": 0,
        "adjustments": [
          {
            "amount": "<string>",
            "account": "<string>",
            "adjustment_type": "sales_tax"
          }
        ],
        "amount": 0,
        "subtotal": 0
      }
    ],
    "customer": {
      "customer_name": "<string>",
      "email": "jsmith@example.com",
      "customer_id": "<string>",
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>",
        "line2": "<string>",
        "state": "<string>"
      }
    },
    "due_date": "2023-11-07T05:31:56Z",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "seller": {
      "name": "<string>",
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>",
        "line2": "<string>",
        "state": "<string>"
      },
      "phone": "<string>",
      "email": "jsmith@example.com"
    },
    "invoice_pdf": "<string>",
    "external_payment_obj_status": "<string>"
  }
]

GET

api

invoices

cURL

curl --request GET \
  --url https://api.uselotus.io/api/invoices/ \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.uselotus.io/api/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://api.uselotus.io/api/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: <api-key>"
  ],
]);

$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://api.uselotus.io/api/invoices/"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.uselotus.io/api/invoices/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "invoice_id": "<string>",
    "invoice_number": "<string>",
    "cost_due": 5000000000,
    "amount": 0,
    "currency": {
      "code": "<string>",
      "name": "<string>",
      "symbol": "<string>"
    },
    "issue_date": "2023-11-07T05:31:56Z",
    "payment_status": "draft",
    "external_payment_obj_id": "<string>",
    "external_payment_obj_type": "stripe",
    "line_items": [
      {
        "name": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "quantity": 5000000000,
        "billing_type": "in_arrears",
        "metadata": {},
        "plan": {
          "plan_name": "<string>",
          "plan_id": "<string>",
          "version_id": "<string>",
          "version": 123
        },
        "subscription_filters": [
          {
            "value": "<string>",
            "property_name": "<string>"
          }
        ],
        "base": 0,
        "adjustments": [
          {
            "amount": "<string>",
            "account": "<string>",
            "adjustment_type": "sales_tax"
          }
        ],
        "amount": 0,
        "subtotal": 0
      }
    ],
    "customer": {
      "customer_name": "<string>",
      "email": "jsmith@example.com",
      "customer_id": "<string>",
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>",
        "line2": "<string>",
        "state": "<string>"
      }
    },
    "due_date": "2023-11-07T05:31:56Z",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "seller": {
      "name": "<string>",
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>",
        "line2": "<string>",
        "state": "<string>"
      },
      "phone": "<string>",
      "email": "jsmith@example.com"
    },
    "invoice_pdf": "<string>",
    "external_payment_obj_status": "<string>"
  }
]

Retrieves an array of invoice objects.

lotus.list_invoices(
    customer_id="cus_1234567890",
)

lotus.list_invoices(
    status=["unpaid"],
)

await lotus.listInvoices({
  customer_id = "cus_1234567890",
});

await lotus.listInvoices({
  status = ["unpaid"],
});

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Query Parameters

customer_id

string | null

A filter for invoices for a specific customer

Minimum string length: 1

payment_status

enum<string>[]

A filter for invoices with a specific payment status

unpaid - unpaid
paid - paid

Available options:

unpaid,

paid

Response

200 - application/json

invoice_id

string

required

invoice_number

string

required

read-only

cost_due

number<double>

required

deprecated

Required range: 0 <= x < 10000000000

amount

number<double>

required

read-only

Required range: -10000000000 < x < 10000000000

currency

object

required

Show child attributes

issue_date

string<date-time>

required

read-only

payment_status

enum<string>

required

read-only

draft - draft
voided - voided
paid - paid
unpaid - unpaid

Available options:

draft,

voided,

paid,

unpaid

external_payment_obj_id

string | null

required

read-only

external_payment_obj_type

enum<string> | null

required

stripe - Stripe
braintree - Braintree

Available options:

stripe,

braintree,

null

line_items

object[]

required

Show child attributes

customer

object

required

Show child attributes

due_date

string<date-time> | null

required

read-only

start_date

string<date>

required

read-only

end_date

string<date>

required

read-only

seller

object

required

Show child attributes

invoice_pdf

string<uri> | null

required

read-only

external_payment_obj_status

string | null