List value receipts | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueReceipts.listValueReceipts({});
}
main();

{
  "data": [
    {
      "id": "vr_9f8b7c6d5e4a3b2c1d0e",
      "status": "completed",
      "publicUrlToken": "abc123xyz789",
      "publicUrl": "https://value-receipts.agentpaid.io/receipt/abc123xyz789",
      "isPublished": true,
      "customerId": "cust_456def789abc",
      "customerName": "Acme Corporation",
      "customerExternalId": "EXT-ACME-001",
      "orderId": "ord_1234567890abcdef",
      "productId": "prod_9876543210fedcba",
      "currency": "USD",
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-31T23:59:59Z",
      "totalDeliveredValue": 12500.75,
      "archivedAt": null,
      "createdAt": "2024-02-01T10:15:30Z"
    }
  ],
  "total": 1
}

List value receipts for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 50

offsetintegerOptional>=0Defaults to 0

customerIdstringOptional

Filter by customer display ID.

externalCustomerIdstringOptional

Filter by customer external ID.

orderIdstringOptional

productIdstringOptional

archivedenumOptionalDefaults to false

Include archived value receipts. Defaults to false.

Allowed values:

Response

200

datalist of objects

totalinteger

Errors

500

Internal Server Error