---
title: "Extract Header Endpoint"
method: POST
path: "/api/v1/extract_header"
---

# Extract Header Endpoint

`POST /api/v1/extract_header`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v1/extract_header`
- Auth: none declared

## Request body

- ExtractHeaderRequest
  - `plan_manager_id` string, required
  - `plan_manager_abn` string, nullable
  - `textract_result` string, nullable
  - `textract_results_s3` object, nullable
  - `first_500_words_text` string, required

## Response `200`

Successful Response

- ExtractHeaderResponse
  - `invoice_data` HeaderData, required
    - `AMOUNT_DUE` number, nullable
    - `INVOICE_DUE_DATE` string, nullable
    - `INVOICE_RECEIPT_DATE` string, nullable
    - `INVOICE_RECEIPT_ID` string, nullable
    - `SUBTOTAL` number, nullable
    - `TAX` number, nullable
    - `TOTAL` number, nullable
    - `VENDOR_ABN_NUMBER` string, nullable
    - `VENDOR_NAME` string, nullable
    - `total_valid` boolean, nullable
    - `BSB` string, nullable
    - `ACCOUNT_NUMBER` string, nullable
    - `abn_checksum_failed` boolean, nullable
  - `NDIS_Participant_Number` union
    - string
    - integer
  - `participant_id` string, nullable
  - `participant_source` string, nullable
  - `participant_active` boolean, nullable
  - `approval_status` string, nullable
  - `participant_alternatives` object[], nullable
  - `multiple_participants` boolean, nullable
  - `no_participant_number` boolean, nullable
  - `participant_names` object[], nullable
  - `participant_age` integer, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-30** `12405f2d8935`: 1 info
  - added the optional property `no_participant_number` to the response with the `200` status
- **2026-09-17** `9d2892eca00b`: 1 info
  - added the optional property `invoice_data/abn_checksum_failed` to the response with the `200` status

[Operation history](https://skmtc.dev/caresquare/apis/caresquare-api/changes/api/v1/extract_header/post.md)

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/d428fe38bf62?raw)