Billing Queries

Interactive examples coming soon...

orderItems :: [OrderItem]

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

hasBalanceDue :: Boolean

if the client has an open, due balance

ArgumentTypeDescription
clientIdID!

searchCoupons :: [Coupon]

ArgumentTypeDescription
limitInt
termString

vendors :: [Vendor]

No arguments.

order :: Order

Gets an order by id

ArgumentTypeDescription
idID!

paymentsTotals :: PaymentsTotals

ArgumentTypeDescription
endDateTime
hideAccountCreditBoolean
locationIds[ID]
methodPaymentMethod
startDateTime

estimatePdf :: String

ArgumentTypeDescription
idID!

searchPackages :: [ProductPackage]

ArgumentTypeDescription
queryString!

ccTerminals :: [String]

ArgumentTypeDescription
locationIdID!

product :: Product

ArgumentTypeDescription
idID!

refundedOrderItems :: [OrderItem]

ArgumentTypeDescription
endDateTime
locationIds[ID]
providerIdID
startDateTime

vendor :: Vendor

ArgumentTypeDescription
idID!

estimates :: [Estimate]

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

bills :: [Bill]

ArgumentTypeDescription
clientIdID!

searchProductables :: [Orderable]

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

estimatesTotals :: EstimatesTotals

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

orders :: [Order]

Lists all orders based on the query

ArgumentTypeDescription
clientIdID
clientTagIds[ID]
endDateTime
hideSubscriptionsBoolean
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
locationIdID
locationIds[ID]
mismatchedBoolean
notUncollectibleBoolean
offsetInt
onlyDiscountedBoolean
onlySubscriptionsBoolean
orderDiscountsBoolean
postedBoolean
providerIdID
startDateTime
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

payments :: [Payment]

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

purchaseOrder :: PurchaseOrder

ArgumentTypeDescription
idID!

inCollections :: Boolean

ArgumentTypeDescription
clientIdID!

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!

purchaseOrders :: [PurchaseOrder]

ArgumentTypeDescription
locationIdID
orderedSinceDate

creditMemosTotals :: CreditMemoTotals

ArgumentTypeDescription
endDateTime
locationIds[ID]
startDateTime

searchProductTypes :: [ProductType]

ArgumentTypeDescription
nameString!

searchProductCategories :: [ProductCategory]

ArgumentTypeDescription
nameString!

invoicePdf :: String

ArgumentTypeDescription
idID!

productsCount :: Int

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

packs :: [Pack]

ArgumentTypeDescription
clientIdID
locationIds[ID]

searchInventoryBuckets :: [InventoryBucket]

ArgumentTypeDescription
nameString!

masterProducts :: [MasterProduct]

No arguments.

products :: [Product]

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

processorPayments :: [ProcessorPayment]

ArgumentTypeDescription
endDateTime!
locationIdID!
startDateTime!

creditMemos :: [CreditMemo]

ArgumentTypeDescription
endDateTime!
limitInt
locationIds[ID]
offsetInt
startDateTime!

ordersTotals :: OrdersTotals

Returns a count of all orders based on a query.

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

orderItemsTotals :: OrderItemsTotals

ArgumentTypeDescription
byInvoiceDateBoolean
endDate
locationIds[ID]
providerIdID
startDate