Skip to content
Fragment
Get started
API Reference
Invoices

Retrieve

client.invoices.retrieve(stringid, RequestOptionsoptions?): InvoiceRetrieveResponse { data }
GET/invoices/{id}

Gets an invoice by ID with balance details

ParametersExpand Collapse
id: string

Invoice ID

ReturnsExpand Collapse
InvoiceRetrieveResponse { data }
data: Data { id, balances, created, 6 more }

Invoice with balance details

id: string

Unique identifier for the invoice

balances: Array<Balance>

Invoice-level balances by currency: payins, payouts, and net (payins - payouts)

currency: string

Currency code

net: Net { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

payins: Payins { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

payouts: Payouts { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

created: string

ISO 8601 timestamp when the invoice was created

formatdate-time
status: "active"

The status of the invoice

users: Array<User>

Users/parties involved in the invoice

id: string

User/party ID

balances: Array<Balance>

Per-currency balance breakdown for this user

currency: string

Currency code

net: Net { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

payins: Payins { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

payouts: Payouts { actual, expected, remaining }
actual: string

Actual amount (represented as string)

expected: string

Expected amount (represented as string)

remaining: string

Remaining amount (expected - actual, represented as string)

version: number

The current version of the invoice. Pass this value when updating to ensure thread safety.

workspaceId: string

Workspace ID this invoice belongs to

lineItems?: Array<LineItem>

List of line items associated with this invoice

id: string

Unique identifier for the line item

amount: string

Amount in smallest currency unit (represented as string for bigint)

currencyCode: "ADA" | "BTC" | "DAI" | 176 more

Currency code (ISO 4217 or crypto)

Accepts one of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: string

Description of the line item

product_id: string

ID of the product/catalog item

type: "payin" | "payout"

The type of the line item

Accepts one of the following:
"payin"
"payout"
user_id: string

External ID of the user associated with this line item

modified?: string

ISO 8601 timestamp when the invoice was last modified

formatdate-time

Retrieve

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const invoice = await client.invoices.retrieve('inv_1234567890');

console.log(invoice.data);
{
  "data": {
    "id": "inv_1234567890",
    "balances": [
      {
        "currency": "USD",
        "net": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        },
        "payins": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        },
        "payouts": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        }
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "status": "active",
    "users": [
      {
        "id": "user_ext_789",
        "balances": [
          {
            "currency": "USD",
            "net": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            },
            "payins": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            },
            "payouts": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            }
          }
        ]
      }
    ],
    "version": 1,
    "workspaceId": "ws_1234567890",
    "lineItems": [
      {
        "id": "item_1234567890",
        "amount": "1000",
        "currencyCode": "USD",
        "description": "Professional services for January 2026",
        "product_id": "prod_1234567890",
        "type": "payout",
        "user_id": "user_ext_456"
      }
    ],
    "modified": "2024-01-13T00:00:00Z"
  }
}
Returns Examples
{
  "data": {
    "id": "inv_1234567890",
    "balances": [
      {
        "currency": "USD",
        "net": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        },
        "payins": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        },
        "payouts": {
          "actual": "5000",
          "expected": "10000",
          "remaining": "5000"
        }
      }
    ],
    "created": "2024-01-13T00:00:00Z",
    "status": "active",
    "users": [
      {
        "id": "user_ext_789",
        "balances": [
          {
            "currency": "USD",
            "net": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            },
            "payins": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            },
            "payouts": {
              "actual": "5000",
              "expected": "10000",
              "remaining": "5000"
            }
          }
        ]
      }
    ],
    "version": 1,
    "workspaceId": "ws_1234567890",
    "lineItems": [
      {
        "id": "item_1234567890",
        "amount": "1000",
        "currencyCode": "USD",
        "description": "Professional services for January 2026",
        "product_id": "prod_1234567890",
        "type": "payout",
        "user_id": "user_ext_456"
      }
    ],
    "modified": "2024-01-13T00:00:00Z"
  }
}