---
title: "Get remittance data by payment reference"
method: POST
path: "/api/v1/remittance_portal/remittance"
---

# Get remittance data by payment reference

`POST /api/v1/remittance_portal/remittance`

## 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/remittance_portal/remittance`
- Auth: none declared

Retrieve invoices and line items associated with a payment reference for remittance portal access

## Request body

- RemittancePortalRequest: Request model for remittance portal endpoint.
  - `payment_ref` string, required: Payment reference to search for
  - `provider_email` string, required: Provider email address
  - `plan_manager_id` string, required: Plan manager ID

## Response `200`

Successful Response

- RemittancePortalResponse: Response model for remittance portal endpoint.
  - `success` boolean, required: Whether the request was successful
  - `message` string, required: Response message
  - `data` object, nullable: Response data containing invoices and line items

## Other responses

- `422`: Validation Error

---

[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)