Get invoice | Paid | Documentation

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

{
  "id": "inv_9f8b7c6d5e4a3b2c1d0e",
  "customerId": "cus_7d8e9f0a1b2c3d4e5f6a",
  "status": "pending",
  "paymentStatus": "partiallyPaid",
  "source": "order_based",
  "startDate": "2024-01-01T00:00:00Z",
  "issueDate": "2024-01-05T10:00:00Z",
  "currency": "USD",
  "taxAmount": 15.75,
  "taxRate": 7.5,
  "taxStatus": "calculated",
  "invoiceTotalExcludingTax": 210,
  "invoiceTotal": 225.75,
  "amountDue": 75.75,
  "amountPaid": 150,
  "amountRemaining": 75.75,
  "creditNotesTotal": 0,
  "createdAt": "2024-01-05T09:45:00Z",
  "updatedAt": "2024-01-20T15:30:00Z",
  "taxExempt": false,
  "displayNumber": "INV-2024-000123",
  "orderId": "ord_4a3b2c1d0e9f8b7c6d5e",
  "endDate": "2024-01-31T23:59:59Z",
  "postedDate": "2024-01-06T12:00:00Z",
  "dueDate": "2024-02-05T23:59:59Z",
  "metadata": {
    "project": "Website Redesign",
    "notes": "Partial payment received"
  },
  "paymentLink": "https://pay.agentpaid.io/invoice/inv_9f8b7c6d5e4a3b2c1d0e/pay",
  "disputeLink": "https://support.agentpaid.io/disputes/inv_9f8b7c6d5e4a3b2c1d0e",
  "publicUrlToken": "a1b2c3d4e5f6g7h8i9j0",
  "billingContactId": "cont_1234567890abcdef"
}

Get an invoice by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200

idstring

customerIdstring

statusenum

paymentStatusenum

Allowed values:

sourceenum

Allowed values:

startDatedatetime

issueDatedatetime

currencystring

taxAmountdouble

taxRatedouble

taxStatusenum

Allowed values:

invoiceTotalExcludingTaxdouble

invoiceTotaldouble

amountDuedouble

amountPaiddouble

amountRemainingdouble

creditNotesTotaldouble

createdAtdatetime

updatedAtdatetime

taxExemptboolean

displayNumberstring or null

orderIdstring or null

endDatedatetime or null

postedDatedatetime or null

dueDatedatetime or null

metadatamap from strings to any or null

paymentLinkstring or null

disputeLinkstring or null

publicUrlTokenstring or null

billingContactIdstring or null

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error