Activities (Base Entity)

Entity›Activity

Activities are the core operational records in TribeCRM — they represent everything from sales opportunities and invoices to tasks, emails, and support tickets. The Activity parent type holds common fields like Subject, Number, Amount, and financial totals shared by all subtypes.

The Activity endpoint provides a unified view across all activity subtypes. Use the subtype-specific endpoints (e.g., Activity_SalesOpportunity, Activity_Invoice) when you need to work with a single type.

Base Entity

Activity is a base entity and cannot be created directly. You must create a concrete subtype. See Subtypes for the full list.

Endpoints

List Activities

Retrieve a paginated list of all activities across all types.

GET/v1/odata/Activity

Single Activity

Retrieve a single activity by its ID.

GET/v1/odata/Activity({id})

With expanded relations:

GET/v1/odata/Activity({id})?$expand=Relationship,Contact,ProductLines

Create Activity

The Activity endpoint does not support direct creation. Use a subtype-specific endpoint instead:

POST/v1/odata/Activity_SalesOpportunity

POST/v1/odata/Activity_Offer

POST/v1/odata/Activity_SalesOrder

POST/v1/odata/Activity_Invoice

POST/v1/odata/Activity_Task

POST/v1/odata/Activity_Event

POST/v1/odata/Activity_SupportTicket

POST/v1/odata/Activity_Project

See Subtypes for the full list.

Update Activity

Update an existing activity. Provide only the fields to update.

PUT/v1/odata/Activity({id})

Delete Activity

Delete an activity by ID.

DELETE/v1/odata/Activity({id})

Subtypes

Activity is the abstract parent type. All activity records are one of these concrete subtypes:

Subtype	OData Entity Set	Description
Sales Opportunities	Activity_SalesOpportunity	Sales pipeline opportunities
Quotes (Offers)	Activity_Offer	Price quotations
Sales Orders	Activity_SalesOrder	Confirmed orders
Invoices	Activity_Invoice	Invoices
Subscriptions	Activity_Subscription	Recurring subscriptions
Tasks	Activity_Task	Tasks / to-dos
Events	Activity_Event	Calendar events
Appointments	Activity_Appointment	Appointments
Emails	Activity_Email	Emails
Projects	Activity_Project	Projects
Support Tickets	Activity_SupportTicket	Support tickets
Work Orders	Activity_WorkOrder	Work orders
Campaigns	Activity_Campaign	Marketing campaigns
Documents	Activity_Document	Documents
LinkedIn Messages	Activity_LinkedInMessage	LinkedIn messages

Subtypes inherit all Activity fields and may add their own specific fields.

Fields

Standard Fields (all entities)

Field	Type	Description
ID	Guid	Primary key (UUID)
_Type	String	Entity type discriminator (e.g., Activity.SalesOpportunity)
_Name	String	Computed display name
SortIndex	Double	Sorting order
CreationDate	DateTimeOffset	Date the record was created
LastMutationDate	DateTimeOffset	Date of the last modification
IsActive	Boolean	Whether the record is active
IsClosed	Boolean	Whether the record is closed

Activity Fields

Field	Type	Description
Subject	String	Activity subject / title
Number	String	Auto-generated activity number (e.g., 2026-00001)
Amount	Double	Activity amount
Currency	String	Currency code (e.g., EUR)
IsVatIncluded	Boolean	Whether prices include VAT
DiscountPercentage	Double	Discount percentage
RelationDescription	String	Description of the linked relation
NumberOfProductLines	Double	Number of product lines
NumberOfOpenTasks	Double	Number of open tasks linked to this activity
NumberOfPlannedActions	Double	Number of planned actions
BillingAmount	Double	Amount to be invoiced
BillingAmountInCurrency	Double	Amount to be invoiced (in currency)
AmountInCurrency	Double	Amount (in currency)

Financial Totals

Field	Type	Description
TotalSalesExcludingVAT	Double	Subtotal excluding VAT
TotalSalesIncludingVAT	Double	Total including VAT
TotalSalesExcludingVATInCurrency	Double	Subtotal excluding VAT (in currency)
TotalSalesIncludingVATInCurrency	Double	Total including VAT (in currency)
VatAmount	Double	VAT amount
VatAmountInCurrency	Double	VAT amount (in currency)
VatAmountIncludingDiscount	Double	VAT amount after discount
TotalDiscountExcludingVAT	Double	Total discount amount
TotalDiscountExcludingVATInCurrency	Double	Total discount amount (in currency)
TotalMargin	Double	Total profit margin
TotalPurchaseAmount	Double	Total purchase/cost amount

Recurring vs Non-Recurring Totals

Field	Type	Description
TotalRecurringSalesExcludingVAT	Double	Recurring subtotal excl. VAT
TotalRecurringSalesIncludingVAT	Double	Recurring total incl. VAT
TotalRecurringDiscountExcludingVAT	Double	Recurring discount
TotalRecurringVatAmount	Double	Recurring VAT
TotalRecurringMargin	Double	Recurring margin
TotalRecurringPurchaseAmount	Double	Recurring cost
TotalNonRecurringSalesExcludingVAT	Double	One-time subtotal excl. VAT
TotalNonRecurringSalesIncludingVAT	Double	One-time total incl. VAT
TotalNonRecurringDiscountExcludingVAT	Double	One-time discount
TotalNonRecurringVatAmount	Double	One-time VAT
TotalNonRecurringMargin	Double	One-time margin
TotalNonRecurringPurchaseAmount	Double	One-time cost

Relationships

Relationship	Target Entity	Cardinality	Description
Relationship	Relationship	N:1	Linked relation (customer/contact)
Contact	Relationship.Person.Contact	N:1	Contact person
ProductLines	ProductLine	1:N	Product lines / line items
Involved	Involved	1:N	Involved parties
LinkedActivities	Activity	1:N	Linked activities
Activity	Activity	N:1	Parent activity
TimeRegistrations	TimeRegistration	1:N	Time registrations
PriceList	PriceList	N:1	Price list
Milestone	ProjectMilestone	N:1	Project milestone
EmployeeAllocations	EmployeeAllocation	1:N	Employee allocations
EventParticipation	EventParticipation	N:1	Event participation details

Expanding Relationships

GET/v1/odata/Activity({id})?$expand=Relationship

GET/v1/odata/Activity({id})?$expand=Relationship,Contact,ProductLines

Navigating Relationships

You can navigate directly to related entities:

GET/v1/odata/Activity({id})/ProductLines

GET/v1/odata/Activity({id})/Involved

DELETE/v1/odata/Activity({id})/PriceList/$ref

Filtering Examples

:::warning Filtering by _Type is not supported To narrow by activity subtype, query that subtype's own entity set instead (e.g. /v1/odata/Activity_Invoice, /v1/odata/Activity_SalesOpportunity). See Filtering by Type. :::

GET/v1/odata/Activity?$filter=contains(Subject, '{Subject}')&$top={top}

GET/v1/odata/Activity?$filter=Amount gt {Amount}&$top={top}

GET/v1/odata/Activity?$filter=Number eq '{Number}'&$top={top}

GET/v1/odata/Activity?$filter=CreationDate gt {CreationDate}&$top={top}

GET/v1/odata/Activity?$filter=IsClosed eq {IsClosed}&$top={top}

GET/v1/odata/Activity?$filter=TotalSalesExcludingVAT gt {TotalSalesExcludingVAT}&$top={top}