FIfireserviceusa
InvoicePayment

Get all payment requests with filtering options

get/api/v1/InvoicePayment/requests

Request

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

Query parameters

statusstring

Filter by status: all, pending, paid, expired, canceled

fromDatestring date-time

Filter from date

toDatestring date-time

Filter to date

dateTypestring

Type of date to filter on: created, sent, lastSent, paid

searchTextstring

Search across invoice numbers, job IDs, customer names, confirmation numbers, and Stripe payment intent IDs

invoiceNumberstring

Filter by invoice number

confirmationNumberstring

Filter by confirmation number

stripeIntentIdstring

Filter by Stripe payment intent ID

jobIdstring

Filter by Job ID

customerNamestring

Filter by customer name

customerEmailstring

Filter by customer email

paymentMethodstring

Filter by payment method: CreditCard, DebitCard, ACH

jobTrxErrorstring

Filter by jobTrxError: any, none, specific error message

glPostErrorstring

Filter by glPostError: any, none, specific error message

cashReceiptErrorstring

Filter by cashReceiptError: any, none, specific error message

pageinteger

Page number

pageSizeinteger

Number of records per page

sortBystring

Sort column

sortDirectionstring

Sort direction (asc/desc)

Response

Success

Changes

No operation changes recorded.