The Invoices API enables you to retrieve invoices. These capabilities are exposed through a single query.

​

invoices()

type Query {
  invoices(
    search: String, 
    startDate: String,
    endDate: String, 
    page: Int, 
    pageSize: Int = 25,
  ): InvoicesSearchConnection!
}

​

Input

​

search

string | undefined Optional search term to filter invoices by. Can find matches by PO Number, invoice number, date, etc.

​

startDate

string | undefined Optional start date to filter invoices by. If provided, it will only return invoices with invoiceDate values after startDate

​

endDate

string | undefined Optional start date to filter invoices by. If provided, it will only return invoices with invoiceDate values after startDate

​

page

integer | undefined Optional number indicating which page to return. Defaults to returning the first page when not provided.

​

pageSize

integer | undefined Optional number indicating how many results per-page to return. Defaults to 25.

​

Response

​

Invoice

​

accountNumber

string | null - Identifier for the account being invoiced. These are assigned by the invoice issuer.

​

invoiceNumber

string - Identifier assigned to the invoice by the invoice issuer.

​

createdAt

string - Date the invoice was issued.

​

orderId

string - Identifier assigned by Sibi to the order associated with the invoice.

​

totalCents

integer - Total amount being invoiced. Given in pennies.

​

taxCents

integer - Tax amount being invoiced. Given in pennies.

​

partner

string - Slug of the organization issuing the invoices. (example: ge, ppg, johnstone)

​

partnerName

string - Name of the organization issuing the invoices. (example: GE Appliances, PPG Paints)

​

partnerIconImageUrl

string - URL to the logo of the organization issuing the invoices.

​

poNumber

string | null - Purchase order number associated with the invoice. This value is defined by the organization that placed the order associated with the invoice.

​

propertyAddress

FulfillmentAddress - Snapshot of the property address associated with the invoice when the order was created.

​

property

InvoiceProperty - The property associated with the order.

​

lineItems

InvoiceLineItem[] - The line items from the order associated with the invoice.

​

InvoiceLineItem

​

description

string | null - Description of the line item.

​

quantity

integer - Quantity of the line item purchased.

​

unitPriceCents

integer - Price of the line item. Given in pennies.

​

sku

string - Stock keeping unit identifier for the line item.

​

serialNumber

string | null - Serial number of the line item. Is not always present.

​

InvoiceProperty

​

externalId

string | null - Identifier assigned to the property by the property owner.