Skip to Content
TillorPodręcznik
Ledger opening balances

Update Ledger Opening Balance

Dostęp

Członek organizacji z tym uprawnieniem:

  • invoicing:manage-opening-balances

Klucz API z zakresami potrzebuje też tego uprawnienia w swoich zakresach.

PATCH
/orgs/{organizationId}/ledger-opening-balances/{id}

Changes an opening balance. Lowering it below what the customer's guarded ledger still holds is refused (409, INVOICE_LEDGER_BALANCE_EXCEEDED). With ledgerBalanceOverride, users with invoicing:override-ledger-balance may take a guarded ledger below zero; the motivation and the violations are recorded on the customer's timeline.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

id*string

Request Body

application/json
  1. body
ledger?integer
Range-9007199254740991 <= value <= 9007199254740991
amount?number
asOfDate?string
Formatdate
reference?string
Length1 <= length <= 120
note?|null
ledgerBalanceOverride?

Response Body

OK

application/json
  1. response
Example Request
curl -X PATCH 'https://api.tillor.eu/orgs//ledger-opening-balances/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
null

Create Ledger Opening Balance POST

Adds an opening balance on a ledger for a customer. A negative amount that takes a guarded ledger below zero is refused (409, `INVOICE_LEDGER_BALANCE_EXCEEDED`); a reference the customer already has on that ledger is refused (409, `LEDGER_OPENING_BALANCE_REFERENCE_EXISTS`). With `ledgerBalanceOverride`, users with invoicing:override-ledger-balance may take a guarded ledger below zero; the motivation and the violations are recorded on the customer's timeline.

Delete Ledger Opening Balance DELETE

Removes an opening balance. Refused (409, `INVOICE_LEDGER_BALANCE_EXCEEDED`) when the customer's guarded ledger would go below zero, for example when the deposit was refunded since. With `ledgerBalanceOverride`, users with invoicing:override-ledger-balance may take a guarded ledger below zero; the motivation and the violations are recorded on the customer's timeline.