Revenues

The revenues resource is used to track revenue.

Revenue object

{
  "id": "019eb9a9-f703-7147-8eee-7bf0a8e70b82",
  "tenant": "019eb9a9-f241-77da-82cd-cf2f36b4e25b",
  "location": null,
  "contact": "019eb9a9-f3dd-7719-a216-6zdgfjh938s6",
  "revenue_identifier": null,
  "amount": 32400,
  "type": "019eb9a9-f3b0-7997-b4f2-f19c1728d2d9",
  "source": "019eb9a9-f3ab-75a7-b167-1bc695219f72",
  "method": "019eb9a9-f3a3-7a11-95ee-5df72db178ba",
  "purpose": "019eb9a9-f3a7-7abd-8637-c184d1dd19ca",
  "campaign": null,
  "notes": null,
  "meta": null,
  "received_at": "2026-06-15 17:36:42",
  "archived_at": null,
  "created_at": "2026-06-12 02:29:43",
  "updated_at": null
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• location
  nullable string
  Unique ID of the location.
• contact
  required string
  Unique ID of the contact who gave the revenue.
• revenue_identifier
  nullable string
  Unique identifier for the revenue within the tenant.
• amount
  required integer
  Amount of the revenue in cents.
• type
  nullable string
  Unique ID of the revenue type.
• source
  nullable string
  Unique ID of the revenue source.
• method
  nullable string
  Unique ID of the revenue method.
• purpose
  nullable string
  Unique ID of the revenue purpose.
• campaign
  nullable string
  Unique ID of the campaign.
• notes
  nullable string
  Notes about the revenue.
• meta
  nullable object
  Additional metadata about the revenue.
• received_at
  required string
  UTC timestamp of when the revenue was received.
• archived_at
  nullable string
  UTC timestamp of when the record was archived.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

Create a revenue

POST /tenants/{tenantId}/revenues

The request body must include a revenue object.

Required permissions

revenues:create locations:read contacts:read options:read

Response

List revenues

GET /tenants/{tenantId}/revenues

This endpoint also supports filtering records to only those associated with specific contact types using query parameters.

• ?member=true: Returns only revenue records associated with contacts that are members. Requires the members:read permission.
• ?member=false: Returns only revenue records associated with contacts that are not members. Requires the members:read permission.
• ?staff=true: Returns only revenue records associated with contacts that are staff. Requires the staff:read permission.
• ?staff=false: Returns only revenue records associated with contacts that are not staff. Requires the staff:read permission.

Required permissions

revenues:read locations:read contacts:read options:read

Response

Read a revenue

GET /tenants/{tenantId}/revenues/{id}

Required permissions

revenues:read locations:read contacts:read options:read

Response

Update a revenue

PATCH /tenants/{tenantId}/revenues/{id}

The request body must include parts of a revenue object.

Required permissions

revenues:update locations:read contacts:read options:read

Response

Delete a revenue

DELETE /tenants/{tenantId}/revenues/{id}

Required permissions

revenues:delete

Response