v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Fees

Get a list of fees

Retrieve a list of fees based on provided filters

Required scopes: flex.community.fees.read

get/api/v2/organizations/{orgSlug}/fees

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by fee id. Supports single id (e.g. _id=xxx) or multiple (e.g. _id[$in]=id1,id2).

companystring

Example:603dfbc260f4054084125d30

Filter by company id.

memberstring

Example:603dfbc260f4054084125d33

Filter by member id.

locationstring

Example:603dfbc260f4054084125d33

Filter by location id.

planstring

Example:603dfbc260f4054084125d33

Filter by plan id.

issueDatestring

Example:issueDate[$gte]=2025-01-01T00:00:00.000Z

Filter by issue date of the fee. Supports date comparison filters: $gt, $gte, $lt, $lte

isRefundableboolean

Example:true

Filter by whether the fee is refundable (e.g. deposit).

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "603dfbc260f4054084125d30",
      "name": "Example Fee Name",
      "price": 20,
      "quantity": 2,
      "company": "603dfbc260f4054084125d30",
      "member": "603dfbc260f4054084125d30",
      "location": "603dfbc260f4054084125d30",
      "plan": "603dfbc260f4054084125d30",
      "issueDate": "2025-03-03T00:00:00.000Z",
      "discount": "603dfbc260f4054084125d33",
      "discountAmount": 5,
      "calculatedDiscountAmount": 5,
      "discountedPrice": 5,
      "isRefundable": true,
      "isPersonal": true,
      "shouldBillInAdvance": true,
      "shouldUseCoins": true,
      "coins": [
        {
          "_id": "594932ea518f3f150d306c89",
          "count": 2
        }
      ],
      "payment": {
        "_id": "603dfbc260f4054084125d30",
        "creditNote": "603dfbc260f4054084125d30"
      },
      "source": "admin",
      "createdAt": "2024-04-12T00:00:00.000Z",
      "createdBy": "6080186f490fcf6e0537ec27",
      "modifiedAt": "2024-05-12T00:00:00.000Z",
      "modifiedBy": "6080186f490fcf6e0537ec54"
    }
  ]
}