Update a draft invoice

curl --request PATCH \
  --url https://api.panoflow.io/v1/collections/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "due_in_days": 30,
  "virtual_account_requested": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({due_in_days: 30, virtual_account_requested: true})
};

fetch('https://api.panoflow.io/v1/collections/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/collections/invoices/{invoice_id}"

payload = {
    "due_in_days": 30,
    "virtual_account_requested": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "object": "invoice",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "number": "<string>",
  "status": "draft",
  "customer": {
    "name": "<string>",
    "id": "<string>",
    "email": "jsmith@example.com"
  },
  "currency": "NGN",
  "line_items": [
    {
      "description": "<string>",
      "quantity": 123,
      "unit_price": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "vat_enabled": true,
  "vat_rate_bps": 5000,
  "subtotal": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "vat": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "total": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "amount_paid": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "amount_due": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "due_in_days": 0,
  "virtual_account_requested": true,
  "pay_page": {
    "slug": "<string>",
    "url": "<string>"
  },
  "settlement_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "reminders_enabled": true,
  "overpaid": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "issued_on": "2026-11-07",
  "due_on": "2026-11-07",
  "days_overdue": 123,
  "virtual_account": {
    "account_number": "8012457739",
    "bank_name": "<string>",
    "account_name": "<string>",
    "status": "active",
    "created_at": "2026-10-27T08:41:00Z",
    "bank_code": "058",
    "closed_at": "2026-10-27T08:41:00Z"
  },
  "next_reminder_on": "2026-11-07",
  "note": "<string>",
  "payments": [
    {
      "method": "transfer",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "received_at": "2026-10-27T08:41:00Z",
      "inbound_credit_id": "<string>",
      "transaction_id": "<string>",
      "payer_name": "<string>",
      "note": "<string>"
    }
  ],
  "activity": [
    {
      "type": "created",
      "at": "2026-10-27T08:41:00Z",
      "actor": {
        "type": "user",
        "id": "<string>",
        "name": "<string>"
      },
      "automatic": true,
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "to": "<string>",
      "inbound_credit_id": "<string>"
    }
  ],
  "sent_at": "2026-10-27T08:41:00Z",
  "paid_at": "2026-10-27T08:41:00Z",
  "voided_at": "2026-10-27T08:41:00Z",
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "metadata": {}
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

PATCH

collections

invoices

{invoice_id}

Update a draft invoice

curl --request PATCH \
  --url https://api.panoflow.io/v1/collections/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "due_in_days": 30,
  "virtual_account_requested": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({due_in_days: 30, virtual_account_requested: true})
};

fetch('https://api.panoflow.io/v1/collections/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/collections/invoices/{invoice_id}"

payload = {
    "due_in_days": 30,
    "virtual_account_requested": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "object": "invoice",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "number": "<string>",
  "status": "draft",
  "customer": {
    "name": "<string>",
    "id": "<string>",
    "email": "jsmith@example.com"
  },
  "currency": "NGN",
  "line_items": [
    {
      "description": "<string>",
      "quantity": 123,
      "unit_price": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "vat_enabled": true,
  "vat_rate_bps": 5000,
  "subtotal": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "vat": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "total": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "amount_paid": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "amount_due": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "due_in_days": 0,
  "virtual_account_requested": true,
  "pay_page": {
    "slug": "<string>",
    "url": "<string>"
  },
  "settlement_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "reminders_enabled": true,
  "overpaid": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "issued_on": "2026-11-07",
  "due_on": "2026-11-07",
  "days_overdue": 123,
  "virtual_account": {
    "account_number": "8012457739",
    "bank_name": "<string>",
    "account_name": "<string>",
    "status": "active",
    "created_at": "2026-10-27T08:41:00Z",
    "bank_code": "058",
    "closed_at": "2026-10-27T08:41:00Z"
  },
  "next_reminder_on": "2026-11-07",
  "note": "<string>",
  "payments": [
    {
      "method": "transfer",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "received_at": "2026-10-27T08:41:00Z",
      "inbound_credit_id": "<string>",
      "transaction_id": "<string>",
      "payer_name": "<string>",
      "note": "<string>"
    }
  ],
  "activity": [
    {
      "type": "created",
      "at": "2026-10-27T08:41:00Z",
      "actor": {
        "type": "user",
        "id": "<string>",
        "name": "<string>"
      },
      "automatic": true,
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "to": "<string>",
      "inbound_credit_id": "<string>"
    }
  ],
  "sent_at": "2026-10-27T08:41:00Z",
  "paid_at": "2026-10-27T08:41:00Z",
  "voided_at": "2026-10-27T08:41:00Z",
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "metadata": {}
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

invoice_id

string

required

Invoice id (ivc_…). The human number (INV-0152) is not accepted here; search with q.

Pattern: ^ivc_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

Partial update of a draft. Same fields as create, all optional, without send.

customer_id

string

A saved customer (cus_…). Replaces the current customer.

customer

object

A new customer. Replaces the current customer.

Show child attributes

line_items

object[]

Replaces every line.

Required array length: 1 - 100 elements

Show child attributes

vat_enabled

boolean

Add VAT at 7.5% of the subtotal.

due_in_days

enum<integer>

Payment terms in days after issue.

Available options:

0,

7,

14,

30

virtual_account_requested

boolean

Give the invoice its own account number when it is sent.

reminders_enabled

boolean

Automatic reminders on or off.

note

string

Note to the customer.

Maximum string length: 500

settlement_account_id

string

Account the money lands in (acc_…). Same rules as on create.

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Response

The updated draft.

An invoice (ivc_…, an alias view of the shared col_ collection table).

string

required

ivc_…

object

string

required

Always invoice.

Allowed value: "invoice"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

updated_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

number

string

required

Human invoice number, sequential per business.

Pattern: ^INV-\d{4,}$

status

enum<string>

required

Invoice state (not a money movement; see CONVENTIONS §8 note in docs/discrepancies). draft → sent → partially_paid → paid; sent / partially_paid → overdue after due_on while money is still owed (an overdue invoice can have part payments; see amount_paid); draft / sent / partially_paid / overdue → void. UI labels: sent → "Awaiting payment", partially_paid → "Part paid".

Available options:

draft,

sent,

partially_paid,

overdue,

paid,

void

customer

object

required

The customer (payer) on an invoice or static virtual account.

Show child attributes

currency

enum<string>

required

ISO 4217. Only NGN is live at launch; others return 422 currency_not_enabled.

Available options:

NGN,

USD,

GBP,

EUR,

GHS,

KES

line_items

object[]

required

Lines in order.

Show child attributes

vat_enabled

boolean

required

Whether VAT is added.

vat_rate_bps

integer

required

Percentage in basis points (50 = 0.5%).

Required range: 0 <= x <= 10000

subtotal

object

required

Sum of line amounts, before VAT.

Show child attributes

vat

object

required

subtotal × vat_rate_bps / 10000, rounded half up to the minor unit. Zero when VAT is off.

Show child attributes

total

object

required

subtotal + vat.

Show child attributes

amount_paid

object

required

Sum of payments.

Show child attributes

amount_due

object

required

"Left to pay": total − amount_paid, never below zero. Zero when paid or void.

Show child attributes

due_in_days

enum<integer>

required

Payment terms.

Available options:

0,

7,

14,

30

virtual_account_requested

boolean

required

Whether the invoice gets (or got) its own account number.

pay_page

object

required

The invoice's pay page. Every invoice has one; it shows 404 to payers while a draft.

Show child attributes

settlement_account

object

required

One of the business's own PanoFlow accounts (owned by the Accounts service).

Show child attributes

reminders_enabled

boolean

required

Automatic reminders on.

overpaid

object

Present when payments exceed the total. The excess stays in the settlement account.

Show child attributes

issued_on

string<date>

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

due_on

string<date>

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

days_overdue

integer

Whole days past due_on, when overdue ("6 days late").

virtual_account

object

The invoice's own (per-invoice, dynamic) account number. Anything paid into it is recorded against this invoice.

Show child attributes

next_reminder_on

string<date>

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

note

string

Note to the customer.

payments

object[]

Money recorded against the invoice, oldest first.

Show child attributes

activity

object[]

Timeline for the drawer. Returned by getInvoice and invoice actions; omitted from lists.

Show child attributes

sent_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

paid_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

voided_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

created_by

object

Who did something. Shown in activity, approvals and the audit log.

Show child attributes

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Update a draft invoice

Authorizations

Headers

Path Parameters

Body

Response