Get invoice status

Check invoice status by provider email and invoice number. Requires X-Plan-Manager-Id header. Returns the same payload shape as the remittance portal.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Request

This endpoint expects an object.

provider_emailstringRequiredformat: "email"

invoice_numberstringRequired

Response

Invoice status

successboolean

messagestring

dataobject

Invoices

Errors

403

Forbidden Error

500

Internal Server Error

$	curl -X POST https://api.caresquareapi.com/api/public/v1/invoices/status \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"provider_email": "provider@example.com",
>	"invoice_number": "INV-2024-001"
>	}'

$	curl -X POST https://api.caresquareapi.com/api/public/v1/invoices/status \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"provider_email": "provider@example.com",
>	"invoice_number": "INV-2024-001"
>	}'