Sign in
Bill

Search Bills

Search for Bill entities.

This endpoint executes a search query for Bills based on the user specified search criteria. The search query is customizable, allowing for complex nested conditions and sorting. The returned list of Bills can be paginated for easier management.

get/organizations/{orgId}/bills/search

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

searchQuerystring

Query for data using special syntax:

  • Query parameters should be delimited using $ (dollar sign).
  • Allowed comparators are:
    • (greater than) >
    • (greater than or equal to) >=
    • (equal to) :
    • (less than) <
    • (less than or equal to) <=
    • (match phrase/prefix) ~
  • Allowed parameters: accountId, locked, billDate, startDate, endDate, dueDate, billingFrequency, id, createdBy, dtCreated, lastModifiedBy, ids.
  • Query example:
    • searchQuery=startDate>2023-01-01$accountId:62eaad67-5790-407e-b853-881564f0e543.
    • This query is translated into: find Bills that startDate is older than 2023-01-01 AND accountId is equal to 62eaad67-5790-407e-b853-881564f0e543.

Note: Using the ~ match phrase/prefix comparator. For best results, we recommend treating this as a "starts with" comparator for your search query.

fromDocumentinteger

fromDocument for multi page retrievals.

pageSizeinteger

Number of Bills to retrieve per page.

NOTE: If not defined, default is 10.

operator'AND' | 'OR'

Search Operator to be used while querying search.

sortBystring

Name of the parameter on which sorting is performed. Use any field available on the Bill entity to sort by, such as accountId, endDate, and so on.

sortOrder'ASC' | 'DESC'

Sorting order.

Response

Returns the Bills matching the search criteria

nextTokenstring

Example response

{
  "data": [
    {
      "timezone": "UTC",
      "currencyConversions": [
        {
          "from": "EUR",
          "to": "USD",
          "multiplier": 1.12
        }
      ]
    }
  ]
}

Changes

Changed in 3 of the 10 revisions of this API.234

  • ac93d1a9e6d911See the full diff
    • ●

      added the new AD_HOC enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b5121See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      api operation id SearchBill removed and replaced with SearchBills

      api-operation-id-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog