curl --request GET \
--url https://api.1club.ai/v1/platform/invoices/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/invoices/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1club.ai/v1/platform/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://api.1club.ai/v1/platform/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: 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://api.1club.ai/v1/platform/invoices/summary"
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://api.1club.ai/v1/platform/invoices/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/invoices/summary")
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{
"timezone": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"billingEntityId": 123,
"invoiced": [
{
"currency": "<string>",
"count": 123,
"subtotal": 123,
"taxAmount": 123,
"totalAmount": 123
}
],
"byStatus": [
{
"status": "<string>",
"currency": "<string>",
"count": 123,
"totalAmount": 123
}
],
"overdue": [
{
"currency": "<string>",
"count": 123,
"totalAmount": 123
}
],
"byBillingEntity": [
{
"billingEntityId": 123,
"name": "<string>",
"invoiced": [
{
"currency": "<string>",
"count": 123,
"subtotal": 123,
"taxAmount": 123,
"totalAmount": 123
}
]
}
]
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Summarize what was invoiced
Totals of the organization’s fiscal invoices over a range of calendar days on the organization’s own clock (timezone in the response). Both bounds are inclusive YYYY-MM-DD dates; with neither, the range is today, and with one, it is that single day. A range may span at most 93 days.
An invoice belongs to the day its invoice date names: a date entered without a time files on that date, and an invoice raised from a sale files on the organization’s local day. Pro-formas are never included.
invoiced excludes void and cancelled invoices; byStatus lists every status, those included. Every amount is grouped by currency - totals in different currencies are never added together. overdue counts unpaid invoices in the range whose due date has passed. byBillingEntity splits invoiced by the company that issued each invoice.
curl --request GET \
--url https://api.1club.ai/v1/platform/invoices/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/invoices/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1club.ai/v1/platform/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://api.1club.ai/v1/platform/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: 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://api.1club.ai/v1/platform/invoices/summary"
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://api.1club.ai/v1/platform/invoices/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/invoices/summary")
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{
"timezone": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"billingEntityId": 123,
"invoiced": [
{
"currency": "<string>",
"count": 123,
"subtotal": 123,
"taxAmount": 123,
"totalAmount": 123
}
],
"byStatus": [
{
"status": "<string>",
"currency": "<string>",
"count": 123,
"totalAmount": 123
}
],
"overdue": [
{
"currency": "<string>",
"count": 123,
"totalAmount": 123
}
],
"byBillingEntity": [
{
"billingEntityId": 123,
"name": "<string>",
"invoiced": [
{
"currency": "<string>",
"count": 123,
"subtotal": 123,
"taxAmount": 123,
"totalAmount": 123
}
]
}
]
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Query Parameters
First day, inclusive. Defaults to endDate, or today.
Last day, inclusive. Defaults to startDate.
Only invoices issued by this billing entity
Response
Invoice totals for the range
The organization's timezone, whose calendar days the range is read on
One entry per currency; void and cancelled invoices excluded. Empty when nothing was invoiced.
Show child attributes
Show child attributes
Every status present in the range, per currency, void and cancelled included
Show child attributes
Show child attributes
Unpaid invoices in the range whose due date has passed, per currency
Show child attributes
Show child attributes
invoiced, split by the billing entity that issued each invoice
Show child attributes
Show child attributes
Was this page helpful?