Update Invoice | Papertracc Docs

curl -X PATCH https://api.papertracc.com/v1/invoices/1243891e-40a8-4a88-8e1f-0397adcbf85e \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "invoice_date": "2026-06-19T10:00:00.000Z",
  "order_id": "ORD-1001-R",
  "subject": "Revised implementation consulting services",
  "due_date": "2026-07-19T10:00:00.000Z",
  "reverse_charge": false
}'

{
  "data": {
    "id": "1243891e-40a8-4a88-8e1f-0397adcbf85e",
    "invoice_reference": "INV-0001",
    "project_id": "spruce-demo",
    "prepared_by": "user-token-hash",
    "amount": "537500.00",
    "total_paid": "0.00",
    "payment_status": "UNPAID",
    "status": "DRAFT",
    "journal_status": "UNPOSTED",
    "currency_code": "NGN",
    "exchange_rate": "1.00",
    "order_id": "ORD-1001",
    "reverse_charge": false,
    "is_overdue": false,
    "approval": 0,
    "content": {},
    "items": [
      {
        "detail": "Consulting hours",
        "tax_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1",
        "quantity": 10,
        "rate": "50000.00",
        "amount": "500000.00",
        "inventory_id": "55a40b4d-a23a-49aa-a417-828913e9a5c8",
        "currency_code": "NGN",
        "sku": "SKU-1001",
        "account_id": "d037d299-3029-4dc7-8e72-172f80f23c4f"
      }
    ],
    "adjustments": [
      {
        "name": "VAT",
        "account_id": "2b0d1461-e52e-4a1a-a69c-11801431c2c9",
        "value": "7.50",
        "type": "PERCENTAGE_RATE",
        "operation": "ADDITION",
        "amount": "45000.00"
      }
    ],
    "payment_schedule": null,
    "customer": {
      "id": "7d2c9c72-392c-4f8d-b3f1-c1fef2c2d501",
      "type": "INDIVIDUAL",
      "email": "john@example.com",
      "phone": "+2348012345678",
      "accounts": [
        {
          "bank": "Spruce Bank",
          "code": "044",
          "vat_id": "78c68f6d-d734-4822-9a6c-73f517a0e5c1",
          "is_default": true,
          "account_name": "John Doe",
          "currency_code": "NGN",
          "account_number": "1234567890"
        }
      ],
      "last_name": "Doe",
      "contact_id": "64595845-34ec-482c-b0fe-ae617a0f8335",
      "created_at": "2026-06-18T10:00:00Z",
      "first_name": "John",
      "project_id": "spruce-demo",
      "company_name": "Acme Corp",
      "display_name": "John Doe",
      "billing_address": {
        "name": "Office",
        "address_one": "12 Marina Road",
        "city": "Lagos",
        "state": "Lagos",
        "country": "Nigeria",
        "country_code": "NG",
        "post_code": "100001",
        "phone": "+2348012345678"
      },
      "shipping_address": {
        "name": "Office",
        "address_one": "12 Marina Road",
        "city": "Lagos",
        "state": "Lagos",
        "country": "Nigeria",
        "country_code": "NG",
        "post_code": "100001",
        "phone": "+2348012345678"
      },
      "payment_term_id": null
    },
    "approvals": [],
    "invoice_date": "2026-06-18T10:00:00Z",
    "due_date": "2026-07-18T10:00:00Z",
    "created_at": "2026-08-19T12:19:57.610806Z",
    "file_url": null,
    "journal_entry_id": null,
    "debit_account_id": null,
    "subject": "Revised Consultancy Fee"
  },
  "status": true,
  "message": "Successfully updated invoice"
}

Updates an invoice’s metadata, line items, adjustments and incentives. Fields left out are unchanged. adjustments replaces the manual adjustments, and an empty array removes them all. Sending payment_term_id rebuilds payment_schedule from that term. Sending a due_date different from the current one replaces the term with that fixed date and clears payment_schedule.

Requires the can_modify_sales_invoice permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

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

identitystring

The identity for the active workspace.

Path parameters

idstringRequired

Invoice ID.

Request

This endpoint expects an object.

invoice_datedatetimeOptional

Must include exactly 3 fractional-second digits, e.g. 2025-12-29T18:00:00.000Z. Timestamps with no fractional seconds, or with a different digit count (e.g. microseconds), are rejected.

exchange_ratedoubleOptional

order_idstringOptional

subjectstringOptional

due_datedatetimeOptional

Must include exactly 3 fractional-second digits, e.g. 2025-12-29T18:00:00.000Z. Timestamps with no fractional seconds, or with a different digit count (e.g. microseconds), are rejected.

payment_term_idstringOptionalformat: "uuid"

Payment term to apply. Takes precedence over due_date. The document’s due dates and any early-payment discount are worked out from the term and returned in payment_schedule.

reverse_chargebooleanOptional

sales_personnel_idstringOptionalformat: "uuid"

Sales personnel to credit for this invoice. Accepts either a ProfileSalesPersonnel id or a Contact id; if a Contact id is given and no sales-personnel record is linked to it yet, one is created automatically.

commissionobjectOptional

Per-invoice override of the workspace’s default commission terms.

itemslist of objectsOptional

Replaces the invoice's line items. Omit the field to keep the existing ones.

adjustmentslist of objectsOptional

Replaces the invoice’s manual adjustments. Send an empty array to remove them all, or omit the field to keep the existing ones. Promotion and loyalty adjustments are managed through incentives and are left in place.

incentivesobjectOptional

When sent, replaces the invoice’s promotions and loyalty redemption; send an empty object to remove them. When omitted, the existing ones are kept and recalculated if items change. Sending adjustments only replaces manual adjustments.

Response

dataobject

statusboolean

messagestring

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error