Get caregiver payout receipt state

GET

/caregiver-payout-receipt-states/{reservationBookingId}/{caregiverPayoutInstructionId}

const url = 'https://example.com/caregiver-payout-receipt-states/example/example?contractAssignmentKey=example&caregiverRole=primary&handoffOrder=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/caregiver-payout-receipt-states/example/example?contractAssignmentKey=example&caregiverRole=primary&handoffOrder=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

supabaseBearerAuth

Parameters

Path Parameters

reservationBookingId

required

string

>= 1 characters

caregiverPayoutInstructionId

required

string

>= 1 characters

Query Parameters

contractAssignmentKey

required

string

>= 1 characters

caregiverRole

required

string

Allowed values: primary assistant

handoffOrder

integer

caregiverId

string

>= 1 characters

Responses

200

Current caregiver payout receipt state

application/json

CaregiverPayoutReceiptStateResponse

object

reservationBookingId

required

string

>= 1 characters

contractAssignmentKey

required

string

>= 1 characters

caregiverPayoutInstructionId

required

string

>= 1 characters

receiptState

required

string

Allowed values: pending acknowledged exception_reported repaired

revision

required

integer

status

required

string

>= 1 characters

reason

required

string | null

>= 1 characters

actorProfileId

required

string | null

>= 1 characters

occurredAt

required

string | null format: date-time

key

additional properties

400

Invalid caregiver payout receipt-state target

401

Supabase bearer token is required

403

Actor cannot view caregiver payout receipt state

503

Caregiver payout receipt-state reader is unavailable