curl --request GET \
--url https://api.1club.ai/v1/platform/reports/amount-due \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/reports/amount-due"
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/reports/amount-due', 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/reports/amount-due",
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/reports/amount-due"
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/reports/amount-due")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/reports/amount-due")
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{
"asOf": "2023-12-25",
"currency": "<string>",
"byPerson": true,
"walletShown": true,
"totals": {
"amountDue": 123,
"aging": {
"current": 123,
"month1": 123,
"month2": 123,
"month3": 123,
"month4Plus": 123
},
"threeMonthsOrMore": 123,
"owing": 123,
"wallet": 123
},
"total": 123,
"limit": 123,
"offset": 123,
"rows": [
{
"kind": "household",
"id": 123,
"name": "<string>",
"contactId": 123,
"amountDue": 123,
"aging": {
"current": 123,
"month1": 123,
"month2": 123,
"month3": 123,
"month4Plus": 123
},
"wallet": 123,
"charges": [
{
"id": 123,
"contactId": 123,
"contactName": "<string>",
"dueDay": "2023-12-25",
"bucket": "current",
"description": "<string>",
"transactionType": "<string>",
"outstanding": 123,
"bookingId": 123,
"membershipId": 123,
"orderId": 123,
"checkinId": 123,
"accountId": 123
}
]
}
]
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Who owes the organization, and for how long
The admin’s Money › Amount Due report as a list: everyone who owes something today, biggest debt first, with what they owe aged by the month each charge fell due (current, 1, 2, 3 and 4+ months), the charges behind it (each with its transaction id), and their Wallet balance beside it, never netted into it.
A row is whoever receives the Statement: a contact in a household rolls up into the household’s row, every member’s charges together, unless byPerson=true lists everyone on their own row. A person’s Amount Due is their Due now on their profile, to the cent. The Wallet is the default company’s, so it is shown (walletShown) only when the report is not narrowed to another company, and people holding only Wallet money are listed after the debtors only when it is not narrowed to a club either. owedFor keeps only the rows owed for that long or longer, with totals summed over them. There is no period: the figures are the ledger now, as of asOf.
Paged with limit and offset; totals and total count every row. Readable with transactions:read. Reports have their own limit of 20 requests a minute, on top of the platform’s.
curl --request GET \
--url https://api.1club.ai/v1/platform/reports/amount-due \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/reports/amount-due"
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/reports/amount-due', 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/reports/amount-due",
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/reports/amount-due"
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/reports/amount-due")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/reports/amount-due")
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{
"asOf": "2023-12-25",
"currency": "<string>",
"byPerson": true,
"walletShown": true,
"totals": {
"amountDue": 123,
"aging": {
"current": 123,
"month1": 123,
"month2": 123,
"month3": 123,
"month4Plus": 123
},
"threeMonthsOrMore": 123,
"owing": 123,
"wallet": 123
},
"total": 123,
"limit": 123,
"offset": 123,
"rows": [
{
"kind": "household",
"id": 123,
"name": "<string>",
"contactId": 123,
"amountDue": 123,
"aging": {
"current": 123,
"month1": 123,
"month2": 123,
"month3": 123,
"month4Plus": 123
},
"wallet": 123,
"charges": [
{
"id": 123,
"contactId": 123,
"contactName": "<string>",
"dueDay": "2023-12-25",
"bucket": "current",
"description": "<string>",
"transactionType": "<string>",
"outstanding": 123,
"bookingId": 123,
"membershipId": 123,
"orderId": 123,
"checkinId": 123,
"accountId": 123
}
]
}
]
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Query Parameters
Response
A page of the report
Was this page helpful?