List all account collections
curl --request GET \
--url https://api.yorlet.com/v1/account_collections \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/account_collections"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/account_collections', 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.yorlet.com/v1/account_collections",
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.yorlet.com/v1/account_collections"
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))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/account_collections")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/account_collections")
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{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "account_collection",
"account_collection_subscription": "<string>",
"amount": 123,
"approved_at": 123,
"available_on": 123,
"building": "<string>",
"canceled_at": 123,
"currency": "gbp",
"description": "<string>",
"destination": "<string>",
"destination_owner_payment": "<string>",
"destination_platform_fee_owner_payment": "<string>",
"destination_type": "<string>",
"documents": {
"invoice_file": "<string>"
},
"expense_code": "<string>",
"fee_code": "<string>",
"fee_discount": 123,
"number": "<string>",
"owner": "<string>",
"owner_balance_transaction": "<string>",
"owner_payment": "<string>",
"owner_payout": "<string>",
"paid_at": 123,
"period": {
"end": 123,
"start": 123
},
"references": {
"invoice_number": "<string>",
"po_number": "<string>"
},
"reporting_type": "<string>",
"unit": "<string>",
"workspace": "<string>",
"account": "<string>",
"deleted": false,
"amount_refunded": 0,
"auto_advance": true,
"destination_platform_fee": 0,
"metadata": {},
"paid": false,
"refunded": false,
"subtotal": 0,
"tax": 0,
"tax_behavior": "exclusive",
"tax_percent": 0,
"tax_refunded": 0,
"total": 0
}
]
}Account Collections
List all account collections
Returns a list of account collections. The account collections are returned sorted by creation date, with the most recent account collections appearing first.
GET
/
v1
/
account_collections
List all account collections
curl --request GET \
--url https://api.yorlet.com/v1/account_collections \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/account_collections"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/account_collections', 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.yorlet.com/v1/account_collections",
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.yorlet.com/v1/account_collections"
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))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/account_collections")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/account_collections")
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{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "account_collection",
"account_collection_subscription": "<string>",
"amount": 123,
"approved_at": 123,
"available_on": 123,
"building": "<string>",
"canceled_at": 123,
"currency": "gbp",
"description": "<string>",
"destination": "<string>",
"destination_owner_payment": "<string>",
"destination_platform_fee_owner_payment": "<string>",
"destination_type": "<string>",
"documents": {
"invoice_file": "<string>"
},
"expense_code": "<string>",
"fee_code": "<string>",
"fee_discount": 123,
"number": "<string>",
"owner": "<string>",
"owner_balance_transaction": "<string>",
"owner_payment": "<string>",
"owner_payout": "<string>",
"paid_at": 123,
"period": {
"end": 123,
"start": 123
},
"references": {
"invoice_number": "<string>",
"po_number": "<string>"
},
"reporting_type": "<string>",
"unit": "<string>",
"workspace": "<string>",
"account": "<string>",
"deleted": false,
"amount_refunded": 0,
"auto_advance": true,
"destination_platform_fee": 0,
"metadata": {},
"paid": false,
"refunded": false,
"subtotal": 0,
"tax": 0,
"tax_behavior": "exclusive",
"tax_percent": 0,
"tax_refunded": 0,
"total": 0
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of account collections.
Was this page helpful?
⌘I