Skip to main content
GET
/
invoices
/
summary
Get an invoice summary
curl --request GET \
  --url https://eu.sequencehq.com/api/invoices/summary \
  --header 'Authorization: <authorization>'
import requests

url = "https://eu.sequencehq.com/api/invoices/summary"

headers = {"Authorization": "<authorization>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/invoices/summary', 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://eu.sequencehq.com/api/invoices/summary",
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: <authorization>"
],
]);

$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://eu.sequencehq.com/api/invoices/summary"

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

req.Header.Add("Authorization", "<authorization>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://eu.sequencehq.com/api/invoices/summary")
.header("Authorization", "<authorization>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/invoices/summary")

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

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

response = http.request(request)
puts response.read_body
{
  "totalsByCurrency": [
    {
      "currency": "GBP",
      "invoiceCount": 12,
      "grossTotal": 15400
    },
    {
      "currency": "USD",
      "invoiceCount": 3,
      "grossTotal": 980.5
    }
  ]
}
This response has no body data.
This response has no body data.
This response has no body data.

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

sequence-version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Query Parameters

invoiceStatus
string

Filter by invoice status. Options: IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED

invoicePaymentStatus
string

Filter by payment status. Options: UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE

customerId
string

Filter by customer id.

billingScheduleId
string

Filter by billing schedule id.

dueBefore
string

Filter by due date before. Format: yyyy-MM-dd

dueAfter
string

Filter by due date after. Format: yyyy-MM-dd

sentBefore
string

Filter by sent date before. Format: yyyy-MM-dd

sentAfter
string

Filter by sent date after. Format: yyyy-MM-dd

invoiceBefore
string

Filter by invoice date before. Format: yyyy-MM-dd

invoiceAfter
string

Filter by invoice date after. Format: yyyy-MM-dd

excludeZeroQuantity
boolean

Exclude invoices with zero quantity.

invoiceCurrency
string

Get invoices for a specific currency (provide a comma-separated list)

Search invoices by invoice number (partial, case-insensitive match)

invoiceNumber
string

Filter by invoice number

netTotal
number

Filter by net total amount

Response

OK

totalsByCurrency
object[]
required

Aggregate totals for the invoices matching the supplied filters, grouped by currency.

Example:
[
{
"currency": "GBP",
"invoiceCount": 12,
"grossTotal": 15400
},
{
"currency": "USD",
"invoiceCount": 3,
"grossTotal": 980.5
}
]