Get a Charge Item Set

get/public/v1/charge-item-sets/{chargeItemSet}

get/public/v1/charge-item-sets/{chargeItemSet}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/charge-item-sets/{chargeItemSet}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
    "reference": "SC-SET-01",
    "name": "Standard Support Coordination Set",
    "charge_rate_pattern": "variable_weekday",
    "gst_code": "P2",
    "archived_at": null
  }
}

Authorization

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

Path parameters

chargeItemSetstringrequired
The charge item set UUID

Response

200application/json

ChargeItemSetResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c
- referencestringrequired
  Example:SC-SET-01
- namestringrequired
  Example:Standard Support Coordination Set
- charge_rate_patternenum<string>required
  Available options:fixed_weekdayflat_ratevariable_weekday
- gst_codeenum<string> | nullrequired
  Available options:P1P2P5
- archived_atstring | nullrequired

Errors

401Unauthenticated
403Authorization error
404Not found