Skip to the page

Praecise Platform

Rivier/ Reference/ accounting

Set a customer's credit limit, terms, hold and dunning

patch/accounting/customers/{key}

Before you call

Credential: Authorization: Bearer $KEY
Scope: accounting:write
Sdk: accounting.customer.update
Cli: accounting customer update

Parameters

keystringrequired
In the path

Request bodyapplication/json, required

creditLimitMinorinteger or null
paymentDaysinteger or null
dunningPausedboolean
onHoldboolean
notesstring
At most 1000 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X PATCH 'https://api.rivier.ai/accounting/customers/{key}' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "creditLimitMinor": 0,
  "paymentDays": 0,
  "dunningPaused": false,
  "onHold": false,
  "notes": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown