Update a credit

patch

https://api.wingspan.app/v3/payments/credits/{creditId}

Update credit display fields, amount before any entries, or strategy while untargeted. A targeted amount must fit the invoice. If-Match accepts the current credit ETag or *.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

creditId

string

required

Body Params

Update name, memo or metadata. Amount can change only before any entries exist and a targeted credit must still fit its invoice. applicationStrategy can switch in either direction only while untargeted; switching to Manual stops automatic application. Complete is terminal. If-Match uses the credit revision.

memo

string | null

Set null to clear the memo; omit to leave it unchanged.

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.

amount

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.

name

string

applicationStrategy

string

enum

Automatic applies at payment on or after startDate. Manual applies only to its target invoice.

Allowed:

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.

If-Match

string

Optimistic-concurrency precondition. On PATCH and lifecycle action POSTs against resources with mutable lifecycle (Invoice, Payable, PayrollRun, Credit, Deduction), supply the ETag returned on the most recent read. Mismatch yields 412 Precondition Failed. If-Match: * accepts any current ETag.

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 credit

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

412Optimistic-concurrency precondition failed (If-Match mismatch)

422Validation error