Billing Queries

Interactive examples coming soon...

bills :: [Bill]

ArgumentTypeDescription
clientIdID!

ccTerminals :: [String]

ArgumentTypeDescription
locationIdID!

creditMemos :: [CreditMemo]

ArgumentTypeDescription
endDateTime!
limitInt
locationIds[ID]
offsetInt
startDateTime!

creditMemosTotals :: CreditMemoTotals

ArgumentTypeDescription
endDateTime
locationIds[ID]
startDateTime

estimatePdf :: String

ArgumentTypeDescription
idID!

estimates :: [Estimate]

ArgumentTypeDescription
clientIdID
closedBoolean
endDateTime
invoicedBoolean
limitInt
locationIdID
locationIds[ID]
offsetInt
providerIdID
startDateTime

estimatesTotals :: EstimatesTotals

ArgumentTypeDescription
closedBoolean
endDateTime
invoicedBoolean
limitInt
locationIds[ID]
offsetInt
providerIdID
startDateTime

hasBalanceDue :: Boolean

if the client has an open, due balance

ArgumentTypeDescription
clientIdID!

inCollections :: Boolean

ArgumentTypeDescription
clientIdID!

invoicePdf :: String

ArgumentTypeDescription
idID!

masterProducts :: [MasterProduct]

No arguments.

order :: Order

Gets an order by id

ArgumentTypeDescription
idID!

orderItems :: [OrderItem]

ArgumentTypeDescription
byInvoiceDateBoolean
categoryIds[ID]
endDateDate
ids[ID]
isReturnedBoolean
limitInt
locationIds[ID]
names[String]
notRenderedBoolean
offsetInt
onlyInventoryBoolean
onlyInvoicedBoolean
onlyPostedBoolean
packageIds[ID]
patientIds[ID]
productIds[ID]
providerIdID
startDateDate
typeIds[ID]
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

orderItemsTotals :: OrderItemsTotals

ArgumentTypeDescription
byInvoiceDateBoolean
endDate
locationIds[ID]
providerIdID
startDate

orders :: [Order]

Lists all orders based on the query

ArgumentTypeDescription
clientIdID
clientTagIds[ID]
endDateTime
hideSubscriptionsBoolean
ids[ID]
includeAccountCreditsBooleanInclude Account Credits on File as of this Instance
includeNegativesBooleanInclude credit memos and not rendered line items as separate virtual negative invoices (typically, you do not ever want to set this to true)
invoicedBoolean
invoicedByDateTime
limitInt
localTimezoneString
locationIdID
locationIds[ID]
mismatchedBoolean
notUncollectibleBoolean
offsetInt
onlyDiscountedBoolean
onlySubscriptionsBoolean
orderDiscountsBoolean
postedBoolean
providerIdID
startDateTime
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

ordersTotals :: OrdersTotals

Returns a count of all orders based on a query.

ArgumentTypeDescription
agingBucketsBoolean
clientTagIds[ID]
endDateTime
hideSubscriptionsBoolean
includeAccountCreditsBoolean
includeNegativesBoolean
invoicedBoolean
localTimezoneString
locationIds[ID]
mismatchedBoolean
notUncollectibleBoolean
onlySubscriptionsBoolean
postedBoolean
providerIdID
startDateTime

packs :: [Pack]

ArgumentTypeDescription
clientIdID
locationIds[ID]

payments :: [Payment]

ArgumentTypeDescription
clientIdID
endDateTime
hideAccountCreditBoolean
hideVoidedBoolean
ids[ID]
limitInt
locationIdID
locationIds[ID]
methodPaymentMethod
methods[PaymentMethod]
offsetInt
onlyPositiveBoolean
startDateTime
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

paymentsTotals :: PaymentsTotals

ArgumentTypeDescription
endDateTime
hideAccountCreditBoolean
locationIds[ID]
methodPaymentMethod
startDateTime

processorPayments :: [ProcessorPayment]

ArgumentTypeDescription
endDateTime!
locationIdID!
startDateTime!

product :: Product

ArgumentTypeDescription
idID!

products :: [Product]

ArgumentTypeDescription
categoryIds[ID]
codeString
excludeChildrenBoolean
ids[ID]
isControlledDrugBoolean
isNonCompensatedBoolean
limitInt
nameString
offsetInt
onlyBelowThresholdID
onlyEnabledAtID
onlyTrackInventoryBoolean
sortBySortProductOptions
typeIds[ID]
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

productsCount :: Int

ArgumentTypeDescription
categoryIds[ID]
codeString
nameString
onlyBelowThresholdID
onlyEnabledAtID
onlyTrackInventoryBoolean
typeIds[ID]

purchaseOrder :: PurchaseOrder

ArgumentTypeDescription
idID!

purchaseOrders :: [PurchaseOrder]

ArgumentTypeDescription
locationIds[ID]
orderedSinceDate

refundedOrderItems :: [OrderItem]

ArgumentTypeDescription
endDateTime
locationIds[ID]
providerIdID
startDateTime

searchCoupons :: [Coupon]

ArgumentTypeDescription
limitInt
termString

searchInventoryBuckets :: [InventoryBucket]

ArgumentTypeDescription
nameString!

searchPackages :: [ProductPackage]

ArgumentTypeDescription
queryString!

searchProductCategories :: [ProductCategory]

ArgumentTypeDescription
nameString!

searchProductTypes :: [ProductType]

ArgumentTypeDescription
nameString!

searchProductables :: [Orderable]

ArgumentTypeDescription
limitIntLimit the number of results returned to the top LIMIT matches (defaults to 10)
locationIdID
patientIdID
searchPackagesBoolean
termString!Search for products by name by specifying the search term
typeFlagsProductTypeFlags

searchProducts :: [Product]

ArgumentTypeDescription
limitIntLimit the number of results returned to the top LIMIT matches (defaults to 10)
locationIdID
termString!Search for products by name by specifying the search term
typeFlagsProductTypeFlags

searchVendors :: [Vendor]

ArgumentTypeDescription
termString!

stripeConnectionToken :: String

ArgumentTypeDescription
locationIdID!

vendor :: Vendor

ArgumentTypeDescription
idID!

vendors :: [Vendor]

No arguments.