# Archive credit note

> Archives the credit note. If the credit note has been posted, it will be reversed in the ledger. A credit note with active links to invoice payables cannot be archived — unlink first.

`POST https://api.light.inc/v1/credit-notes/{creditNoteId}/archive`

## Note

A posted credit note is reversed in the ledger and ends in ARCHIVED , not back in DRAFT , and there is no unarchive. A POSTED note with links fails with CREDIT_NOTE_CANNOT_BE_ARCHIVED_WHEN_LINKED : unlink it first, which also reverses any clearing.

## Authorization

- API key
- Bearer token

See https://light.inc/docs/getting-started/authentication.

## Path parameters

- `creditNoteId` (string, uuid, required)


## Response

- `lines.grossTransactionAmount.amount` — Unsigned integer in minor units. The direction is in `dcSign`; a negative value is rejected.
- `lines.netTransactionAmount.amount` — Unsigned integer in minor units. The direction is in `dcSign`; a negative value is rejected.
- `lines.taxTransactionAmount.amount` — Unsigned integer in minor units. The direction is in `dcSign`; a negative value is rejected.
- `localCurrencyFxRate` — Echoes the override you sent; `null` when Light applies its own rate, not the rate that was applied.
- `groupCurrencyFxRate` — Echoes the override you sent; `null` when Light applies its own rate, not the rate that was applied.

```json
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 100000,
  "businessPartnerName": "string",
  "businessPartnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "DRAFT",
  "description": "string",
  "currency": "USD",
  "postingDate": "2026-01-15",
  "documentDate": "2026-01-15",
  "valuationDate": "2026-01-15",
  "areLinesWithTax": true,
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creditNoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "grossTransactionAmount": {
        "amount": 100000,
        "dcSign": "D"
      },
      "netTransactionAmount": {
        "amount": 100000,
        "dcSign": "D"
      },
      "description": "string",
      "ledgerTaxId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxTransactionAmount": {
        "amount": 100000,
        "dcSign": "D"
      },
      "ledgerAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z",
      "accrualTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accrualStartDate": "2026-01-15",
      "accrualEndDate": "2026-01-15",
      "accrualDefaultDuration": 0
    }
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "localCurrencyFxRate": 0,
  "groupCurrencyFxRate": 0,
  "senderEmail": "string",
  "documentName": "string"
}
```

Values above are generated from the schema: the shapes and types are real, the values are placeholders.

## Code

```bash
curl -X POST "https://api.light.inc/v1/credit-notes/3c90c3cc-0d44-4b50-8888-8dd25736052a/archive" \
  -H "Authorization: Basic YOUR_API_KEY"
```

---

Full page: https://light.inc/docs/api-reference/v1--credit-notes/archive-credit-note · Index: https://light.inc/docs/llms.txt