Invoices

Show / Hide

The Invoices GET API returns the job data such as status, summary, items, etc. associated to an invoice.

GET = https://api.servicetitan.com/v1/invoices?{query-string}

get/v1/invoices

Request

  • Base URL: https://api.servicetitan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.servicetitan.com/v1/invoices
  • Auth: none declared

Query parameters

JobIdinteger
JobNumberstring
BusinessUnitIdinteger
CustomerIdinteger
BatchIdinteger
AdjustmentToIdinteger
Status'Pending' | 'Posted' | 'Exported'
InvoicedOnAfterstring date-time
InvoicedOnBeforestring date-time
TotalGreaternumber double
TotalLessnumber double
Numberstring
NumberGreaterstring
NumberLessstring
NumericNumberinteger
NumericNumberGreaterinteger
NumericNumberLessinteger
ModifiedAfterstring date-time
PaymentNamestring
PaymentStatus'Pending' | 'Posted' | 'Exported'
PaymentSettlementStatus'NotSettled' | 'Settled' | 'NotSet'
SettlementStatus'NotSettled' | 'Settled'
PaymentSettlementDatestring date-time
PaymentDatestring date-time
BalanceFilter.Balancenumber double
BalanceFilter.Comparer'Equals' | 'NotEquals' | 'Greater' | 'Less'
OrderBystring
OrderByDirectionstring
ActiveOnlyboolean
CreatedAfterstring date-time
CreatedBeforestring date-time
Idsinteger[]
Pageinteger
PageSizeinteger

Response

Success

pageinteger required
pageSizeinteger required
totalCountinteger required
hasMoreboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.