List all Charges for a Task

get/public/v1/tasks/{task}/charges

get/public/v1/tasks/{task}/charges

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/tasks/{task}/charges' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "c1h2a3r4-g5e6-47f8-9a0b-1c2d3e4f5a6b",
      "date": "2024-01-15T10:30:00+00:00",
      "quantity": 1.5,
      "is_primary": true,
      "unit_cost": 5000,
      "total_cost": 7500,
      "status": "pending",
      "support_item_number": "07_002_0106_8_3",
      "charge_item": {
        "id": "c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c",
        "reference": "SUPPORT_COORD_L2",
        "number": "07_001_0106_8_3",
        "name": "Support Coordination Level 2",
        "unit": "H",
        "price": 10044,
        "gst_code": "P2",
        "default_claim_type": "Direct",
        "archived_at": null
      },
      "invoice": {
        "id": "i1n2v3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

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

taskstringrequired
The task UUID

Query parameters

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 TaskChargeResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:c1h2a3r4-g5e6-47f8-9a0b-1c2d3e4f5a6b
- datestringrequired
  Example:2024-01-15T10:30:00+00:00
- quantitynumber | nullrequired
  Example:1.5
- is_primarybooleanrequired
  Example:true
- unit_costintegerrequired
  Example:5000
- total_costintegerrequired
  Example:7500
- statusstringrequired
  Example:pending
- support_item_numberstringrequired
  Example:07_002_0106_8_3
- charge_itemobject | nullrequired
  ▶Show 9 child attributesHide 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
- invoiceobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:i1n2v3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e
metaobjectrequired
▶Show 5 child attributesHide 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
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors