List Invoices

GET

/api/Invoices

curl --request GET \
  --url 'https://example.com/api/Invoices?Status=Draft' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of invoices for a merchant. Supports filtering by status (Draft, Sent, Paid, Overdue, Void) and member, plus free-text search.

GET /api/invoices?merchantId=...&status=Overdue

Authorizations

• Bearer

Parameters

Query Parameters

MerchantId

string format: uuid

Status

string

Allowed values: Draft Sent Paid Overdue Void

MemberId

string format: uuid

Search

string

Page

integer format: int32

PageSize

integer format: int32

Responses

200

Paginated list of invoices.

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

invoiceNumber

string

nullable

memberId

string format: uuid

nullable

clientName

string

nullable

clientDetail

string

nullable

issueDate

string format: date-time

dueDate

string format: date-time

nullable

total

number format: double

currency

string

nullable

status

string

Allowed values: Draft Sent Paid Overdue Void

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "status": "Draft"
    }
  ]
}