Skip to content
API Docs

requestedPayments

Fetch paginated Requested Payments collection

Arguments

after · Cursor · Cursor to fetch results after
only_unpaid · Boolean · (DEPRECATED) Use status_filter instead
sender_id · ID · will return all requested payments with this ID as the sender or recipient
status_filter · String · Can be paid, partial or unpaid

Returns

[RequestedPayment!]

Example 

query requestedPayments(
  $after: Cursor
  $keywords: String
  $offset: Int
  $only_unpaid: Boolean
  $preview: Boolean
  $sender_id: ID
  $sort_by: String
  $order_by: RequestedPaymentOrderKeys
  $status_filter: String
  $page_size: Int
) {
  requestedPayments(
    after: $after
    keywords: $keywords
    offset: $offset
    only_unpaid: $only_unpaid
    preview: $preview
    sender_id: $sender_id
    sort_by: $sort_by
    order_by: $order_by
    status_filter: $status_filter
    page_size: $page_size
  ) {
    appointment
    appointment_id
    balance_due
    billing_item_id
    billing_items
    cms1500_id
    cms1500_service_date
    currency
    cursor
    date_to_show
    debt_decimal
    details
    email_sent_at
    id
    invoice_id
    invoice_type
    is_manually_paid
    is_preview
    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
    user_package_selection
    write_off_amount
    write_offs
  }
}