Delete an account

Deletes an account together with its balances. A balance that still owes pending fees (0527) or that other balances still owe pending fees to (0528) is refused with 422. A state that cannot be established answers 503 (0520) and may be retried. The CRM instrument linked to the account is soft-deleted. In every fee package of the ledger, a fee whose creditAccount is the account’s alias is removed and the alias leaves waivedAccounts; a package left without fees is disabled. In billing packages, a debitAccountAlias, creditAccountAlias or maintenanceCreditAccount equal to the alias is cleared and the package is disabled; the alias leaves accountTarget.aliases, and the package is disabled only when that list empties. These effects happen before the account is deleted. If one of them fails, the account stays in place and the request may be retried.

DELETE /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}

Delete an account

cURL

curl --request DELETE \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'

422

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

Authorization · string

Bearer token (forwarded to the service)

Path Parameters

organization_id · string · required

Organization ID (UUID)

ledger_id · string · required

Ledger ID (UUID)

account_id · string · required

Account ID (UUID)

Response

204

No Content