Create a Service

post/public/v1/ndis-plans/{plan}/services

Creates a Service against an NDIS Plan. The Service inherits its start and end dates from the Plan, so they are not accepted here, and amount is given in cents. management_type takes the same values this API returns and filters on: ndia, plan or self.

An unscheduled_service is funded by charge_items, and may nominate one of them as the remaining_units_charge_item. A scheduled_service is funded by a charge_item_set (or charge_item_sets) and/or charge_items, and cannot have a remaining_units_charge_item. Every charge item and charge item set must belong to the same support category as the Service.

Leave has_funding_schedule off to fund the Service as a single period spanning the Plan. A funding schedule is only available on a PACE plan, and its plan_service_periods must cover the Plan dates without gaps and sum to amount.

post/public/v1/ndis-plans/{plan}/services

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/ndis-plans/{plan}/services' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "amount": 1,
  "support_category": "string",
  "management_type": "ndia",
  "type": "scheduled_service",
  "charge_items": [
    {
      "id": "string"
    }
  ],
  "charge_item_set": {
    "id": "string"
  },
  "charge_item_sets": [
    {
      "id": "string"
    }
  ],
  "remaining_units_charge_item": {
    "id": "string"
  },
  "service_coordinator": {
    "id": "string"
  },
  "reconciled_amount": 0,
  "reconciled_date": "string",
  "has_funding_schedule": true,
  "plan_service_periods": [
    {
      "amount": 0,
      "start": "string",
      "end": "string"
    }
  ]
}'

Response

{
  "data": {
    "id": "p1l2a3n4-s5e6-47v8-9b0c-1d2e3f4a5b6c",
    "name": "Level 2 Coordination",
    "amount": 1000000,
    "management_type": "ndia",
    "type": "unscheduled_service",
    "status": "current",
    "start": "2024-01-01T00:00:00+00:00",
    "end": "2024-12-31T00:00:00+00:00",
    "participant": {
      "id": "p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
      "full_name": "John Doe"
    },
    "plan": {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "start": "2024-01-01",
      "end": "2024-12-31"
    },
    "support_category": {
      "name": "Support Coordination",
      "prefix": "07",
      "group": "Capacity"
    },
    "service_coordinator": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com"
    },
    "charge_items": [
      {
        "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
      }
    ],
    "charge_item_sets": [
      {
        "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

planstringrequired
The plan UUID

Body

application/json

namestringrequiredmax length 255
amountintegerrequired≥ 1≤ 1000000000
support_categorystringrequired
management_typeenum<string>required
Available options:ndiaplanself
typeenum<string>required
Available options:scheduled_serviceunscheduled_service
charge_itemsobject[]max items 100
▶Show 1 child attributesHide child attributes
- idstringrequired
charge_item_setobject
▶Show 1 child attributesHide child attributes
- idstring
charge_item_setsobject[]max items 100
▶Show 1 child attributesHide child attributes
- idstringrequired
remaining_units_charge_itemobject
▶Show 1 child attributesHide child attributes
- idstring | null
service_coordinatorobject
▶Show 1 child attributesHide child attributes
- idstring | null
reconciled_amountinteger | null≥ 0
reconciled_datestring | null
has_funding_scheduleboolean
plan_service_periodsobject[] | nullmin items 1max items 60
▶Show 3 child attributesHide child attributes
- amountintegerrequired≥ 0
- startstringrequired
- endstringrequired

Response

200application/json

PlanServiceResource

dataobjectrequired
▶Show 14 child attributesHide child attributes
- idstringrequired
  Example:p1l2a3n4-s5e6-47v8-9b0c-1d2e3f4a5b6c
- namestringrequired
  Example:Level 2 Coordination
- amountintegerrequired
  Example:1000000
- management_typeenum<string>required
  Available options:planselfndiaunknown
- typestring | nullrequired
  Example:unscheduled_service
- statusstringrequired
  Example:current
- startstringrequired
  Example:2024-01-01T00:00:00+00:00
- endstringrequired
  Example:2024-12-31T00:00:00+00:00
- participantobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  full_namestringrequired
  Example:John Doe
- planobjectrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
  startstringrequired
  Example:2024-01-01
  endstringrequired
  Example:2024-12-31
- support_categoryobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  namestringrequired
  Example:Support Coordination
  prefixstringrequired
  Example:07
  groupstringrequired
  Example:Capacity
- service_coordinatorobject | nullrequired
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  first_namestringrequired
  Example:John
  last_namestringrequired
  Example:Doe
  emailstringrequired
  Example:john.doe@example.com
- charge_itemsobject[]required
  ▶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
- charge_item_setsobject[]required
  ▶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_patternstringrequired
  Example:variable_weekday
  gst_codestring | nullrequired
  Example:P2
  archived_atstring | nullrequired

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors