Command Palette

Search for a command to run...

Log In
Get help

List Charge Items

get/public/v1/charge-items

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

  • filter[search]string

    Partial match on the name, reference, or number.

    Example:Transport
  • filter[status]string

    Filter by status. One of: active, archived, all.

    Example:active
  • sortstring

    Sort the results. Prefix with '-' for descending. One of: number, name, price.

    Example:name
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of ChargeItemResource

  • dataobject[]required
    ▶Show 9 child attributes
    • idstringrequired
      Example:c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c
    • referencestringrequired
      Example:SUPPORT_COORD_L2
    • numberstringrequired
      Example:07_001_0106_8_3
    • namestringrequired
      Example:Support Coordination Level 2
    • unitstringrequired
      Example:H
    • priceintegerrequired
      Example:10044
    • gst_codestringrequired
      Example:P2
    • default_claim_typestring | nullrequired
      Example:Direct
    • archived_atstring | nullrequired
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error