Query Merchant Invoices

Return a paginated list of matching merchant invoices.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

merchantId
string

Merchant to show entries for

status
Array of strings (MerchantInvoiceStatus)

Filter by invoice status

Items Enum: "draft" "outstanding" "near_due" "due" "overdue" "paid" "cancelled" "defaulted"
issuedOnFromInclusive
string <date>

Return invoices that were issued at or after this date in ISO-8601 format.

Example: issuedOnFromInclusive=2024-11-22
issuedOnToInclusive
string <date>

Return invoices that were created at or before this timestamp in ISO-8601 format.

Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/transactions/invoices
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.