Billing Queries

Interactive examples coming soon...

accountsReceivableBalance :: AccountsReceivableBalance

Returns a client's accounts receivable balance.

Argument	Type	Description
clientId	ID

bills :: [Bill]

Argument	Type	Description
clientId	ID!

ccTerminals :: [String]

Argument	Type	Description
locationId	ID!

creditMemos :: [CreditMemo]

Argument	Type	Description
end	DateTime!
limit	Int
locationIds	[ID]
offset	Int
start	DateTime!
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

creditMemosTotals :: CreditMemoTotals

Argument	Type	Description
end	DateTime
locationIds	[ID]
start	DateTime

estimatePdf :: String

Argument	Type	Description
id	ID!

estimates :: [Estimate]

Argument	Type	Description
clientId	ID
closed	Boolean
end	DateTime
invoiced	Boolean
limit	Int
locationId	ID
locationIds	[ID]
offset	Int
providerId	ID
start	DateTime
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

estimatesTotals :: EstimatesTotals

Argument	Type	Description
clientId	ID
closed	Boolean
end	DateTime
invoiced	Boolean
limit	Int
locationIds	[ID]
offset	Int
providerId	ID
start	DateTime

hasBalanceDue :: Boolean

if the client has an open, due balance

Argument	Type	Description
clientId	ID!

inCollections :: Boolean

Argument	Type	Description
clientId	ID!

invoicePdf :: String

Argument	Type	Description
coownerClientId	ID
id	ID!

ledgerEntries :: [LedgerEntry]

Argument	Type	Description
end	DateTime
localTimezone	String
locationIds	[ID]
start	DateTime

ledgerEntryTotals :: LedgerEntryTotals

Argument	Type	Description
end	DateTime
localTimezone	String
locationIds	[ID]
start	DateTime

masterProducts :: [MasterProduct]

No arguments.

order :: Order

Gets an order by id

Argument	Type	Description
id	ID!

orderItems :: [OrderItem]

Argument	Type	Description
byInvoiceDate	Boolean
categoryIds	[ID]
endDate	Date
excludeHistorical	Boolean
ids	[ID]
includeDeclined	Boolean
isReturned	Boolean
limit	Int
locationIds	[ID]
names	[String]
notRendered	Boolean
offset	Int
onlyControlledDrugs	Boolean
onlyInventory	Boolean
onlyInvoiced	Boolean
onlyPosted	Boolean
packageIds	[ID]
patientIds	[ID]
productIds	[ID]
providerId	ID
providerIds	[ID]
startDate	Date
typeIds	[ID]
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

orderItemsTotals :: OrderItemsTotals

Argument	Type	Description
byInvoiceDate	Boolean
end	Date
locationIds	[ID]
onlyControlledDrugs	Boolean
onlyInvoiced	Boolean
providerId	ID
providerIds	[ID]
start	Date

orders :: [Order]

Lists all orders based on the query

Argument	Type	Description
clientId	ID
clientTagIds	[ID]
end	DateTime
excludeHistorical	Boolean
hideSubscriptions	Boolean
ids	[ID]
includeAccountCredits	Boolean	Include Account Credits on File as of this Instance
includeNegatives	Boolean	Include credit memos and not rendered line items as separate virtual negative invoices (typically, you do not ever want to set this to true)
invoiced	Boolean
invoicedBy	DateTime
limit	Int
localTimezone	String
locationId	ID
locationIds	[ID]
mismatched	Boolean
notUncollectible	Boolean
offset	Int
onlyDiscounted	Boolean
onlySubscriptions	Boolean
orderBy	InvoiceSortFieldEnum
posted	Boolean
providerId	ID
start	DateTime
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

ordersTotals :: OrdersTotals

Returns a count of all orders based on a query, excludes datasync imported orders.

Argument	Type	Description
agingBuckets	Boolean
clientId	ID
clientTagIds	[ID]
end	DateTime
excludeHistorical	Boolean
excludeHistoricalTotals	Boolean
hideSubscriptions	Boolean
includeAccountCredits	Boolean
includeNegatives	Boolean
invoiced	Boolean
localTimezone	String
locationIds	[ID]
mismatched	Boolean
notUncollectible	Boolean
onlySubscriptions	Boolean
posted	Boolean
providerId	ID
start	DateTime

packs :: [Pack]

Argument	Type	Description
clientId	ID
locationIds	[ID]

payments :: [Payment]

Argument	Type	Description
clientId	ID
end	DateTime
excludeHistorical	Boolean
hideAccountCredit	Boolean
hideNegativeAccountCredits	Boolean
hideVoided	Boolean
ids	[ID]
limit	Int
locationId	ID
locationIds	[ID]
method	PaymentMethod
methods	[PaymentMethod]
offset	Int
onlyPositive	Boolean
sort	PaymentSort
start	DateTime
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

paymentsTotals :: PaymentsTotals

Argument	Type	Description
end	DateTime
excludeHistorical	Boolean
hideAccountCredit	Boolean
locationIds	[ID]
method	PaymentMethod
start	DateTime

processorPayments :: [ProcessorPayment]

Argument	Type	Description
end	DateTime!
locationId	ID!
start	DateTime!

product :: Product

Argument	Type	Description
id	ID!

productManufacturer :: ProductManufacturer

Argument	Type	Description
id	ID!

productManufacturers :: [ProductManufacturer]!

Argument	Type	Description
name	String

productManufacturersPaginated :: ProductManufacturerPage!

Argument	Type	Description
after	String
before	String
name	String

products :: [Product]

Argument	Type	Description
categoryIds	[ID]
code	String
diagnosticCode	String
excludeChildren	Boolean
hasDiagnosticCode	Boolean
ids	[ID]
isControlledDrug	Boolean
isNonCompensated	Boolean
limit	Int
name	String
offset	Int
onlyBelowThreshold	ID
onlyEnabledAt	ID
onlyTrackInventory	Boolean
sku	String
sortBy	SortProductOptions
typeIds	[ID]
updatedAtEnd	NaiveDateTime
updatedAtStart	NaiveDateTime

productsCount :: Int

Argument	Type	Description
categoryIds	[ID]
code	String
diagnosticCode	String
excludeChildren	Boolean
name	String
onlyBelowThreshold	ID
onlyEnabledAt	ID
onlyTrackInventory	Boolean
sku	String
typeIds	[ID]

productsInStockCount :: Decimal

Argument	Type	Description
locationId	ID!

purchaseOrder :: PurchaseOrder

Argument	Type	Description
id	ID!

purchaseOrders :: [PurchaseOrder]

Argument	Type	Description
locationIds	[ID]
orderedSince	Date

refundedOrderItems :: [OrderItem]

Argument	Type	Description
end	DateTime
locationIds	[ID]
providerId	ID
providerIds	[ID]
start	DateTime

returnedOrderItems :: [ReturnedOrderItem]

Argument	Type	Description
end	DateTime
locationIds	[ID]
providerId	ID
providerIds	[ID]
start	DateTime

searchCoupons :: [Coupon]

Argument	Type	Description
limit	Int
term	String

searchInventoryBuckets :: [InventoryBucket]

Argument	Type	Description
name	String!

searchPackages :: [ProductPackage]

Argument	Type	Description
query	String!

searchProductCategories :: [ProductCategory]

Argument	Type	Description
name	String!

searchProductTypes :: [ProductType]

Argument	Type	Description
name	String!

searchProductables :: [Orderable]

Argument	Type	Description
limit	Int
locationId	ID
patientId	ID
searchPackages	Boolean
term	String!	Search products by name using this search term
typeFlags	ProductTypeFlags

searchProducts :: [Product]

Argument	Type	Description
limit	Int	Limit the number of results returned to the top LIMIT matches (defaults to 10)
locationId	ID
term	String!	Search for products by name by specifying the search term
typeFlags	ProductTypeFlags

searchVendors :: [Vendor]

Argument	Type	Description
term	String!

stripeConnectionToken :: String

Argument	Type	Description
locationId	ID!

stripePublishableKey :: String

Argument	Type	Description
locationId	ID

vendor :: Vendor

Argument	Type	Description
id	ID!

vendors :: [Vendor]

No arguments.