Skip to main content
GET
/
account
/
invoices
Get Invoices
curl --request GET \
  --url https://api.fyatu.com/api/v3/account/invoices \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Invoices retrieved successfully",
  "data": {
    "invoices": [
      {
        "invoiceId": "INV-2026-01",
        "period": "2026-01",
        "subtotal": 49,
        "totalAmount": 49,
        "paidAmount": 49,
        "currency": "USD",
        "status": "PAID",
        "issuedAt": "2026-01-01T00:00:00+00:00",
        "dueDate": "2026-01-15",
        "paidAt": "2026-01-10T08:22:00+00:00"
      },
      {
        "invoiceId": "INV-2025-12",
        "period": "2025-12",
        "subtotal": 49,
        "totalAmount": 49,
        "paidAmount": 20,
        "currency": "USD",
        "status": "PARTIALLY_PAID",
        "issuedAt": "2025-12-01T00:00:00+00:00",
        "dueDate": "2025-12-15",
        "paidAt": null
      }
    ],
    "pagination": {
      "page": 1,
      "perPage": 20,
      "totalItems": 2,
      "totalPages": 1
    }
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2026-01-15T14:35:00+00:00"
  }
}

Overview

Retrieve a paginated list of billing invoices issued to your business account. Invoices are generated monthly for subscription-based pricing plans and may also be issued for outstanding fees.

Pagination

ParameterDefaultMax
page1-
perPage20100

Response Fields

FieldTypeDescription
invoiceIdstringUnique invoice identifier
periodstringBilling period in YYYY-MM format
subtotalnumberAmount before any adjustments
totalAmountnumberTotal amount due
paidAmountnumberAmount already paid
currencystringAlways USD
statusstringPENDING, PAID, PARTIALLY_PAID, OVERDUE, or VOID
issuedAtstringISO 8601 timestamp when invoice was issued
dueDatestring|nullDue date in YYYY-MM-DD format
paidAtstring|nullISO 8601 timestamp when invoice was fully paid

Invoice Statuses

StatusDescription
PENDINGInvoice issued, payment not yet received
PAIDInvoice fully paid
PARTIALLY_PAIDPartial payment received; remaining balance outstanding
OVERDUEPast due date without full payment
VOIDInvoice cancelled

Example Usage

const response = await fetch('https://api.fyatu.com/api/v3/account/invoices?page=1&perPage=10', {
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

const { data } = await response.json();

console.log(`Total invoices: ${data.pagination.totalItems}`);
data.invoices.forEach(inv => {
  const outstanding = inv.totalAmount - inv.paidAmount;
  console.log(`Invoice ${inv.invoiceId} (${inv.period}): $${inv.totalAmount}${inv.status}`);
  if (outstanding > 0) {
    console.log(`  Outstanding: $${outstanding.toFixed(2)}`);
  }
});

Use Cases

  1. Billing overview: See all invoices and their payment status
  2. Outstanding balance: Find unpaid or partially paid invoices
  3. Payment history: Confirm when invoices were settled

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

page
integer
default:1

Page number (default: 1)

Required range: x >= 1
perPage
integer
default:20

Items per page (default: 20, max: 100)

Required range: 1 <= x <= 100

Response

Invoices retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object