List Invoices

get/public/v1/invoices

get/public/v1/invoices

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

Response

{
  "data": [
    {
      "id": "i1n2v3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "number": "INV-2024-0001",
      "date": "2024-01-15T00:00:00+00:00",
      "due_date": "2024-02-14T00:00:00+00:00",
      "management_type": "plan",
      "total": 25000,
      "status": "awaiting-payment",
      "participant": {
        "id": "i1p2a3r4-c5d6-47e8-9f0a-1b2c3d4e5f6a"
      },
      "plan_manager": {
        "id": "i1p2m3a4-d5e6-47f8-9a0b-1c2d3e4f5a6b"
      },
      "charges": [
        {
          "id": "c1h2r3g4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
          "date": "2024-01-15T10:30:00+00:00",
          "quantity": 2.5,
          "unit_cost": 5000,
          "total_cost": 12500,
          "claim_type": "direct",
          "cancellation_reason": "No show",
          "claim_reference": "CLM-123456",
          "support_item_number": "07_002_0106_8_3",
          "charge_item": {
            "id": "c1i2t3m4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
            "name": "Support Coordination",
            "reference": "SUPPORT_COORD_L2",
            "number": "07_002_0106_8_3"
          },
          "support": {
            "id": "s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b"
          },
          "shift": {
            "id": "s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c"
          }
        }
      ]
    }
  ],
  "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.

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 InvoiceResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:i1n2v3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- numberstringrequired
  Example:INV-2024-0001
- datestringrequired
  Example:2024-01-15T00:00:00+00:00
- due_datestringrequired
  Example:2024-02-14T00:00:00+00:00
- management_typeenum<string>required
  Available options:planselfndiaunknown
- totalintegerrequired
  Example:25000
- statusstringrequired
  Example:awaiting-payment
- participantobjectrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:i1p2a3r4-c5d6-47e8-9f0a-1b2c3d4e5f6a
- plan_managerobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:i1p2m3a4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- chargesobject[]required
  ▶Show 12 child attributesHide child attributes
  idstringrequired
  Example:c1h2r3g4-b5c6-47d8-9e0f-1a2b3c4d5e6f
  datestringrequired
  Example:2024-01-15T10:30:00+00:00
  quantitynumber | nullrequired
  Example:2.5
  unit_costintegerrequired
  Example:5000
  total_costnumberrequired
  Example:12500
  claim_typeenum<string>required
  Available options:CANCDirectIRSSNF2FREPWTHLTTRAN
  cancellation_reasonenum<string> | nullrequired
  Available options:NSDFNSDHNSDONSDT
  claim_referencestring | nullrequired
  Example:CLM-123456
  support_item_numberstringrequired
  Example:07_002_0106_8_3
  charge_itemobject | nullrequired
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:c1i2t3m4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  namestringrequired
  Example:Support Coordination
  referencestring | nullrequired
  Example:SUPPORT_COORD_L2
  numberstringrequired
  Example:07_002_0106_8_3
  supportobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
  shiftobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c
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

Command Palette

Authorization

Query parameters

Response

Errors