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 or null

messagestring or null

dataobject or null

Invoices

1	import requests
2
3	url = "https://api.caresquareapi.com/api/public/v1/invoices/status"
4
5	payload = {
6	"provider_email": "provider@example.com",
7	"invoice_number": "INV-2024-001"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

Authentication

Request

Response

Errors