Update invoice | Paid | Documentation

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

{
  "id": "string",
  "customerId": "string",
  "status": "building",
  "paymentStatus": "pending",
  "source": "order_based",
  "startDate": "2024-01-15T09:30:00Z",
  "issueDate": "2024-01-15T09:30:00Z",
  "currency": "string",
  "taxAmount": 1.1,
  "taxRate": 1.1,
  "taxStatus": "not_applicable",
  "invoiceTotalExcludingTax": 1.1,
  "invoiceTotal": 1.1,
  "amountDue": 1.1,
  "amountPaid": 1.1,
  "amountRemaining": 1.1,
  "creditNotesTotal": 1.1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "taxExempt": true,
  "displayNumber": "string",
  "orderId": "string",
  "endDate": "2024-01-15T09:30:00Z",
  "postedDate": "2024-01-15T09:30:00Z",
  "dueDate": "2024-01-15T09:30:00Z",
  "metadata": {},
  "paymentLink": "string",
  "disputeLink": "string",
  "publicUrlToken": "string",
  "billingContactId": "string",
  "purchaseOrderReference": "string"
}

Update an invoice by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Request

Body

metadatamap from strings to any or nullOptional

Response

200

idstring

customerIdstring

statusenum

paymentStatusenum

sourceenum

startDatedatetime

issueDatedatetime

currencystring

taxAmountdouble

taxRatedouble

taxStatusenum

invoiceTotalExcludingTaxdouble

invoiceTotaldouble

amountDuedouble

amountPaiddouble

amountRemainingdouble

creditNotesTotaldouble

createdAtdatetime

updatedAtdatetime

taxExemptboolean

displayNumberstring or nullOptional

orderIdstring or nullOptional

endDatedatetime or nullOptional

postedDatedatetime or nullOptional

dueDatedatetime or nullOptional

metadatamap from strings to any or nullOptional

paymentLinkstring or nullOptional

disputeLinkstring or nullOptional

publicUrlTokenstring or nullOptional

billingContactIdstring or nullOptional

purchaseOrderReferencestring or nullOptional

Purchase order reference stamped on this invoice.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error