OBJECT

RequestedPayment

A request, from a provider to a client, to make a payment

link GraphQL Schema definition

  • type RequestedPayment {
  • # The appointment associated with this requested payment
  • appointment: Appointment
  • # The ID of the appointment associated with this requested payment
  • appointment_id: String
  • # The id of the filled form that completes the request
  • billing_item_id: String
  • # The payments that completes the request
  • #
  • # Arguments
  • # only_successful: Only return successful billing items
  • billing_items(only_successful: Boolean): [BillingItem!]!
  • # The ID of the CMS1500 to pay for
  • cms1500_id: String
  • # The CMS1500 service date
  • cms1500_service_date: String
  • # The currency of the requested payment (invoice)
  • currency: String
  • # The relevant date to show
  • date_to_show: String
  • # Balance to pay
  • debt: Int @deprecated( reason: "use debt_decimal instead" )
  • # The debt, including decimals
  • debt_decimal: Float
  • # The details of the invoice (based off of associated item)
  • details: String
  • # The datetime that the share email was last sent, nil if never
  • email_sent_at: String
  • # The unique identifier of the payment
  • id: ID!
  • # The generated invoice ID
  • invoice_id: String
  • # The type of invoice
  • invoice_type: String
  • # True if requested payment was manually paid
  • is_manually_paid: Boolean
  • # True if the invoice is still in preview mode
  • is_preview: Boolean!
  • # Extra details on the invoice
  • notes: String
  • # The offering to purchase
  • offering: Offering
  • # The ID of the offering to buy
  • offering_id: String
  • # The requested payer. This will return null if the requested payer exists as a
  • # client in Healthie
  • other_requested_payer: RequestedPayer
  • # The datetime that the invoice was paid
  • paid_at: String
  • # Percent from total price which has been paid (if status == Partial)
  • paid_percent: Int
  • # price of payment requested
  • price: String
  • # The recipient (client)
  • recipient: User
  • # The ID of the recipient (client)
  • recipient_id: String
  • # Individual responsible for payment. If user_id, the user exists in Healthie,
  • # otherwise the individual doesn't have a Healthie account.
  • requested_payer: RequestedPayer
  • # The ID of the requested payer
  • requested_payer_id: String
  • # The template used to create this requested payment
  • requested_payment_template: RequestedPaymentTemplate
  • # The sender (provider)
  • sender: User
  • # The ID of the sender (provider)
  • sender_id: String
  • # The service date
  • service_date: String
  • # The services provided
  • services_provided: String
  • # The status of the request
  • status: String
  • # User Package Selection connected to this requested payment
  • user_package_selection: UserPackageSelection
  • }