Customer

Update customer balance

Updates the store-specific balance for a customer. Requires the stores.customers.update permission.

patch/stores/{storeId}/customers/{customerId}/balance

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/customers/:customerId/balance/patch.ts
A function with typed inputs. Its response is checked against the schema.

storeIdstring uuid required

The ID of the store.

customerIdstring uuid required

The ID of the customer whose balance to update.

newBalancenumber required

The new balance to set for the customer. Must be zero or positive.

commentstring nullable

Optional comment or reason for this balance update, for audit purposes.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

dataunknown

No recorded changes to this operation across all 1 revision of this API.