Get invoices for an order | Paid

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

[
  {
    "id": "string",
    "displayId": "string",
    "organizationId": "string",
    "customerId": "string",
    "orderId": "string",
    "status": "draft",
    "currency": "string",
    "subtotal": 1.1,
    "tax": 1.1,
    "total": 1.1,
    "amountPaid": 1.1,
    "amountDue": 1.1,
    "dueDate": "2024-01-15T09:30:00Z",
    "paidAt": "2024-01-15T09:30:00Z",
    "voidedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "customer": {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "externalId": "string",
      "phone": "string",
      "employeeCount": 1.1,
      "annualRevenue": 1.1,
      "taxExemptStatus": "none",
      "creationSource": "manual",
      "creationState": "active",
      "website": "string",
      "billingAddress": {
        "line1": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "country": "string",
        "line2": "string"
      },
      "metadata": {}
    }
  }
]

Retrieves all invoices associated with a specific order.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

orderIdstringRequired

The order ID (can be internal ID or display ID)

Response

Success response

idstringformat: "uuid"

displayIdstring

Human-readable invoice number

organizationIdstringformat: "uuid"

customerIdstringformat: "uuid"

orderIdstringformat: "uuid"

statusenum

currencystring

subtotaldouble

Total before tax (in smallest currency unit)

taxdouble

Tax amount (in smallest currency unit)

totaldouble

Total amount including tax (in smallest currency unit)

amountPaiddouble

Amount already paid (in smallest currency unit)

amountDuedouble

Amount still due (in smallest currency unit)

dueDatedatetime

paidAtdatetime or null

voidedAtdatetime or null

createdAtdatetime

updatedAtdatetime

customerobject

Errors

403

Forbidden Error

404

Not Found Error