Skip to main content
GET
/
v1
/
account_collections
List all account collections
curl --request GET \
  --url https://api.yorlet.com/v1/account_collections \
  --header 'Authorization: <api-key>'
{
  "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

Authorization
string
header
required

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.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required