Skip to content
Hoursmith Docs
APIReferenceTeam payouts

list Team Bills

list Team Bills. Read-only. Owner/Admin tokens with read scope only. Studio+ retains finalized bills and recorded payment history after Agency downgrade; drafts require Agency. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.

GET
/team-payouts/bills

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

cursor?string

Opaque cursor bound to the caller, filters and sort; reuse unchanged.

limit?integer

Page size; default 50.

sort?string

Defaults to -createdAt. Allowed sort fields for bills: id, number, status, issueDate, dueDate, total, amountPaid, createdAt, updatedAt. Prefix - for descending.

payeeId?string
currency?string

Supported currency. Bills use bill currency; payments use actual transfer currency.

clientId?string
projectId?string
from?string
to?string
search?string
status?string
paymentStatus?string
outstandingOnly?boolean

Approved bills with a positive balance, including partial payments.

overdueOnly?boolean

Outstanding bills due before today in the workspace payout calendar.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/team-payouts/bills"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "number": "string",      "status": "DRAFT",      "paymentStatus": "UNPAID",      "revision": 0,      "currency": "string",      "total": "string",      "amountPaid": "string",      "remaining": "string",      "subtotal": "string",      "adjustmentTotal": "string",      "serviceFrom": "2019-08-24",      "serviceTo": "2019-08-24",      "issueDate": "2019-08-24",      "dueDate": "2019-08-24",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "approvedAt": "2019-08-24T14:15:22Z",      "deletedAt": "2019-08-24T14:15:22Z",      "note": "string",      "voidReason": "string",      "payeeSnapshot": {},      "agencySnapshot": {},      "lineGroupBy": "string",      "showProjectName": true,      "showTaskName": true,      "lines": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "kind": "string",          "description": "string",          "timeEntryId": "string",          "projectId": "string",          "taskId": "string",          "workDate": "2019-08-24",          "durationSeconds": 0,          "hourlyRate": "string",          "amount": "string",          "quantity": "string",          "unitPrice": "string",          "sourceSnapshot": {}        }      ],      "payments": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed",          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",          "currency": "string",          "amount": "string",          "paidDate": "2019-08-24",          "method": "string",          "savedMethodId": "string",          "reference": "string",          "note": "string",          "createdAt": "2019-08-24T14:15:22Z",          "status": "RECORDED",          "reversedAt": "2019-08-24T14:15:22Z",          "reversalReason": "string",          "settlementCurrency": "string",          "settlementAmount": "string",          "exchangeRate": "string",          "settlementMode": "string",          "allocations": [            {              "billId": "b9de0a53-2363-44cf-9760-a7ddf29fedb4",              "number": "string",              "currency": "string",              "amount": "string",              "cashAmount": "string",              "cashCurrency": "string",              "links": {                "app": "string",                "payee": "string",                "project": "string",                "task": "string"              }            }          ],          "links": {            "app": "string",            "payee": "string",            "project": "string",            "task": "string"          }        }      ],      "links": {        "app": "string",        "payee": "string",        "project": "string",        "task": "string"      }    }  ],  "pagination": {    "limit": 1,    "nextCursor": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?

list Team Payees

Read-only. Owner/Admin tokens with read scope only. Agency plan required. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.

list Team Payments

Read-only. Owner/Admin tokens with read scope only. Studio+ retains finalized bills and recorded payment history after Agency downgrade; drafts require Agency. Generic member endpoints never expose compensation. Dates are ISO calendar transport values; money is a decimal string. Links require an authenticated Owner/Admin app session. Unknown and repeated query parameters return 422.