Update an invoice

patch

https://api.wingspan.app/v3/payments/invoices/{invoiceId}

Update mutable fields on a Created or Opened Invoice. Omitted fields are left unchanged; send null to clear a nullable field. A Paid or PaidOffPlatform Invoice accepts only metadata; any other schema-valid field returns 409. Empty metadata is a no-op. Omit lineItems and acceptedPaymentMethods when unchanged; explicitly empty arrays return 422 for every invoice status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

string

required

Body Params

lineItems

array of objects

length ≥ 1

lineItems

Writable non-collaborator line-item fields. Existing collaborator splits cannot be replaced through a line-item PATCH.

description

string

lineItemType

string

enum

Allowed:

totalCost

double

Use totalCost OR quantity + unitCost, not both

quantity

double

unitCost

double

A monetary amount as a JSON number in major units, with decimal places carrying the minor units defined for its currency (USD/EUR: 2, JPY: 0, BHD: 3, ...) — e.g. 100.00. Never a string and never minor-unit (cent) integers. The currency comes from the enclosing resource's currency field; amounts with more decimal places than the currency supports are rejected with 422 ValidationError. Wingspan converts to exact minor units at the service boundary, so callers never need sub-minor-unit precision.

unit

string

detail

string

discount

object

Per-line discount — a percentage or a fixed amount (not both). Supplying both mutually-exclusive members returns 422 ConflictingFields.

accounting

object

Generic accounting classification dimensions that map cleanly into external bookkeeping systems (QuickBooks, Xero, NetSuite, Sage). These are the set of fields accounting systems consistently support as line-item dimensions. Fields are optional; populate only what's relevant to the customer's chart of accounts. Wingspan stores and returns these values verbatim. Mapping them into a provider's native identifiers is a separate integration concern.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

dueDate

date

invoiceNumber

string

notes

string

acceptedPaymentMethods

array of objects

length ≥ 1

acceptedPaymentMethods

Allowed:

Payment settlement classification. Book is read-side only and describes a transfer settled entirely on Wingspan's ledger; it is derived from payout routing and is not currently accepted on pay requests.

lateFeeHandling

object

Late-fee rule applied to overdue invoices — a percentage or a fixed amount, assessed on a cadence. For recurring invoices the cadence is re-phased to each generated invoice's due date. Supplying both mutually-exclusive members returns 422 ConflictingFields.

creditFeeHandling

object

Credit-card processing-fee split for an invoice — who bears the CC fee. Set payeeFeePercentage / payerFeePercentage (a split summing to 100), or payerFlatFeePercentage (the payer pays this flat %). Supplying both mutually-exclusive members returns 422 ConflictingFields.

notificationPreferences

object

Per-invoice email controls.

metadata

object

quickbooks

object

Link this invoice to a QBO Invoice/Payment created out-of-band, and/or suppress quickbooks-sender's own sync. Send only the leaves being changed; omitted leaves are left unchanged.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated invoice

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

501This operation is not yet available