SuitePortal

Transactions API

API endpoints for transaction data.

Transactions API

This documentation is currently being developed. Check back soon for complete content.

List Transactions

GET /v1/transactions

Parameters

ParameterTypeDescription
typestringTransaction type (invoice, salesorder, etc.)
statusstringStatus filter
customerIdstringFilter by customer
dateFromstringStart date
dateTostringEnd date

Response

{
  "data": [
    {
      "id": "txn_123",
      "type": "invoice",
      "documentNumber": "INV-001",
      "date": "2025-01-03",
      "amount": 1500.00,
      "balance": 1500.00,
      "status": "open"
    }
  ],
  "meta": {
    "total": 50
  }
}

Get Transaction

GET /v1/transactions/:id

Response

{
  "data": {
    "id": "txn_123",
    "type": "invoice",
    "documentNumber": "INV-001",
    "lineItems": [...]
  }
}

Get Transaction PDF

GET /v1/transactions/:id/pdf

Returns PDF document.