Skip to content
Healthie API Docs

requestedPayments

Fetch paginated Requested Payments collection

Arguments

keywords · String · Filters results by matching against invoice ID or a full-text search on requested payment fields.
only_unpaid · Boolean · DEPRECATED: Use status_filter instead
preview · Boolean · When true, includes preview requested payments that have not yet been formally created.
sender_id · ID · Filters for requested payments where this ID matches the sender or recipient.
status_filter · String · Can be paid, partial or unpaid.
sort_by · String · DEPRECATED: Use order_by instead.
order_by · RequestedPaymentOrderKeys · Specifies the field and direction by which to sort the requested payments results.
after · Cursor · Cursor to fetch results after

Returns

[RequestedPayment!]

Example 

query requestedPayments(
  $keywords: String
  $only_unpaid: Boolean
  $preview: Boolean
  $sender_id: ID
  $status_filter: String
  $sort_by: String
  $order_by: RequestedPaymentOrderKeys
  $offset: Int
  $page_size: Int
  $after: Cursor
) {
  requestedPayments(
    keywords: $keywords
    only_unpaid: $only_unpaid
    preview: $preview
    sender_id: $sender_id
    status_filter: $status_filter
    sort_by: $sort_by
    order_by: $order_by
    offset: $offset
    page_size: $page_size
    after: $after
  ) {
    appointment
    appointment_id
    balance_due
    billing_item_id
    billing_items
    cms1500_id
    cms1500_service_date
    created_at
    currency
    cursor
    date_to_show
    debt_decimal
    details
    email_sent_at
    id
    invoice_id
    invoice_type
    is_manually_paid
    is_preview
    metadata
    notes
    offering
    offering_id
    offering_price_at_invoice_creation
    other_requested_payer
    paid_at
    paid_percent
    price
    recipient
    recipient_id
    requested_payer
    requested_payer_id
    requested_payment_template
    sender
    sender_id
    service_date
    services_provided
    status
    updated_at
    user_package_selection
    write_off_amount
    write_offs
  }
}