Perform a search and aggregation

get

https://trac-demo.stage.pebble.cloud/api/v1/orgs/{org_id}/aggregate_transactions

Search for transactions across all members and return aggregated income and expenditure and count of matches only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

Query Params

string

Run a text search across the table fields.

member_txns

boolean

Return transactions for all members in an organization

count_field

string

Aggregate the count of transactions by the field. Field is set in a namespace.field format (e.g core.type).

sum_field

string

Aggregate the sum of transactions by the field. Field is set in a namespace.field format (e.g core.type).

parent_org

boolean

Signifies that the org_id passed in the parameters is a parent org and to return transactions for that organization and all of its children organizations.

cancelled_txns

boolean

Returns only cancelled transactions if true or only not cancelled transactions if false

meta.entityType.eq[]

string

Filter by entityType in the core meta using eq.

meta.memberId.eq[]

string

Filter by memberId in the meta namespace using eq. This is a ulid string.

meta.memberDetails.memberType.eq

string

Filter by memberDetails.memberType in the meta namespace using eq. This is a string.

meta.transactionId.eq[]

string

Filter by transactionId in the core meta using eq.

meta.purseId.eq[]

string

Filter by purseId in the core meta using eq.

meta.purseId.ne[]

string

Filter by purseId in the core meta using ne.

core.transactionDate.eq

date-time

Filter by transactionDate in the core namespace using eq. This is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.

core.transactionDate.lt

date-time

Filter by transactionDate in the core namespace using lt. This is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.

core.transactionDate.le

date-time

Filter by transactionDate in the core namespace using le. This is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.

core.transactionDate.gt

date-time

Filter by transactionDate in the core namespace using gt. This is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.

core.transactionDate.ge

date-time

Filter by transactionDate in the core namespace using ge. This is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.

core.reconciled.eq

boolean

Filter by reconciled in the core namespace using eq.

core.type.eq[]

string

Filter by type in the core namespace using eq.

core.type.ne[]

string

Filter by type in the core namespace using ne.

core.amountAsInteger.gt

integer

Filter by amountAsInteger in the core namespace using gt.

core.amountAsInteger.lt

integer

Filter by amountAsInteger in the core namespace using lt.

core.amountAsInteger.eq

integer

Filter by amountAsInteger in the core namespace using eq.

parentPay.status.eq

string

Filter by status in the parentPay namespace using eq.

arbor.status.eq

string

Filter by status in the arbor namespace using eq.

tali.bankAccount.eq[]

integer

Filter by bankAccount in the tali namespace using eq.

tali.costcentre.eq[]

string

Filter by costcentre in the tali namespace using eq.

tali.giftAid.eq

boolean

Filter by giftAid in the tali namespace using eq.

tali.transactionClass.eq

string

Filter by transactionClass in the tali namespace using eq.

tali.transactionClass.ne

string

Filter by transactionClass in the tali namespace using ne.

tali.referenceNumber.ge

integer

Filter by referenceNumber in the tali namespace using ge.

tali.referenceNumber.le

integer

Filter by referenceNumber in the tali namespace using le.

tali.bankDeposit

boolean

Filter transactions according to whether they are part of a bank deposit.

tali.bankDeposit.eq[]

uuid

Filter by bankDeposit UUIDs in the tali namespace using eq.

tali.bankDeposit.ne[]

uuid

Filter by bankDeposit UUIDs in the tali namespace using ne.

till.paymentMethods.eq[]

string

Filter by paymentMethods in the till namespace using eq.

till.productDetails.outlet_name.eq[]

string

Filter by the productDetails.outlet_name in the till namespace using eq.

till.outletName.eq[]

string

Filter by outletName in the till namespace using eq.

Responses

200OK

400Bad Request

401Requires authentication

403Forbidden

404Resource not found