List invoices

GET

/v1/invoices

const url = 'https://api.meridiantrack.com/v1/invoices?limit=50';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.meridiantrack.com/v1/invoices?limit=50' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Parameters

Query Parameters

limit

integer

default: 50 <= 200

cursor

string

status

string

Filter by invoice status

clientId

string

Filter by client ID

Responses

200

List of invoices

application/json

object

items

Array<object>

object

string

invoiceNumber

integer

formattedInvoiceNumber

string

clientId

string

clientName

string

status

string

Allowed values: draft sent paid overdue void

currency

string

issueDate

string

dueDate

string

subtotal

number

total

number

createdAt

string format: date-time

updatedAt

string format: date-time

nextCursor

Opaque cursor for the next page

string

hasMore

Whether more results exist

boolean

Example

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