Update a credit note | Lucanto

curl -X PATCH https://app.lucanto.eu/api/v1/workspaces/42/credit_notes/1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "document": {
    "purchaser_id": 12345
  }
}'

{
  "id": 1,
  "type": "credit_note",
  "status": "draft",
  "currency": "EUR",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T10:00:00Z",
  "number": "CN-2024-0001",
  "issue_date": "2023-01-15",
  "delivery_date": "2023-01-15",
  "exchange_rate": "1.0000",
  "included_in_turnover": true,
  "reverse_charge": true,
  "reverse_charge_text": "Reverse charge applied according to EU VAT rules.",
  "discount_description": "Seasonal discount",
  "discount_percentage": "5.00",
  "discount_amount": "25.00",
  "order_number": "ORD-7890",
  "text_opening": "Thank you for your business.",
  "text_closing": "Please contact us if you have any questions.",
  "footer_note": "This credit note is valid for 30 days.",
  "recipient_note": "Customer requested credit for returned items.",
  "internal_note": "Processed by accounting department.",
  "pdf_language": "en",
  "pdf_locale": "en_US",
  "pdf_compact_mode": true,
  "hide_signature": true,
  "delivery_type": "email",
  "sent_status": "sent",
  "email_sent_at": "2024-01-15T09:30:00Z",
  "seen_timestamp": "2024-01-15T09:45:00Z",
  "purchaser_id": 12345,
  "supplier_id": 67890,
  "bank_account_id": 555,
  "project_id": 101,
  "document_items": [
    {
      "id": 1,
      "name": "Returned Widget Model X",
      "description": "Credit for returned defective Widget Model X",
      "order": 1,
      "quantity": "2",
      "measure_unit": "pcs",
      "unit_price": "250.00",
      "vat_rate": "21.00",
      "discount_description": "Bulk return discount",
      "discount_percentage": "5.00",
      "discount_unit_price": "237.50",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:45:00Z"
    }
  ],
  "purchaser": {
    "id": 12345,
    "registration_id": "12345678",
    "tax_id": "CZ12345678",
    "vat_id": "CZ12345678",
    "vat_payer_type": "standard",
    "vat_period": "monthly",
    "email": "client@example.com",
    "phone_number": "+420123456789",
    "web": "https://clientwebsite.com",
    "invoice_address": {
      "id": 1001,
      "name": "Client Company s.r.o.",
      "contact": "John Doe",
      "street": "123 Business St.",
      "municipality": "Prague",
      "postal_code": "11000",
      "country_id": 203
    },
    "postal_address": {
      "id": 1002,
      "name": "Client Company s.r.o.",
      "contact": "John Doe",
      "street": "123 Business St.",
      "municipality": "Prague",
      "postal_code": "11000",
      "country_id": 203
    }
  },
  "supplier": {
    "id": 67890,
    "registration_id": "87654321",
    "tax_id": "CZ87654321",
    "vat_id": "CZ87654321",
    "vat_payer_type": "standard",
    "vat_period": "monthly",
    "email": "sales@supplier.com",
    "phone_number": "+420987654321",
    "web": "https://supplierwebsite.com",
    "invoice_address": {
      "id": 2001,
      "name": "Supplier Ltd.",
      "contact": "Jane Smith",
      "street": "456 Supplier Ave.",
      "municipality": "Brno",
      "postal_code": "60200",
      "country_id": 203
    },
    "postal_address": {
      "id": 2002,
      "name": "Supplier Ltd.",
      "contact": "Jane Smith",
      "street": "456 Supplier Ave.",
      "municipality": "Brno",
      "postal_code": "60200",
      "country_id": 203
    }
  }
}

Partial update. The type field is intentionally NOT updatable. Updating an issued credit note is allowed but rare — the document has already been accounted for as a VAT correction.

Authentication

AuthorizationBearer

Devise JWT issued via POST /api/v1/auth/sign_in. Used by mobile and SPA clients. Revoked tokens are tracked in api_jwt_denylists.

AuthorizationBearer

Lucanto API key. Three prefixes:

lct_pat_<random><checksum> — personal access token (owner: User)
lct_live_<random><checksum> — workspace token, live data
lct_test_<random><checksum> — workspace token, sandbox account (Phase 3)

Issue keys at /settings/api_keys (personal) or /:workspace_id/settings/api_keys (workspace). Plaintext token is shown once and never again.

Lucanto API key. Three prefixes: - `lct_pat_<random><checksum>` — personal access token (owner: User) - `lct_live_<random><checksum>` — workspace token, live data - `lct_test_<random><checksum>` — workspace token, sandbox account (Phase 3) Issue keys at `/settings/api_keys` (personal) or `/:workspace_id/settings/api_keys` (workspace). Plaintext token is shown once and never again.

Path parameters

workspace_idlongRequired>=1

Workspace (account) ID. The numeric ID shown in your URLs.

idlongRequired>=1

Credit note ID

Request

This endpoint expects an object.

documentobjectRequired

Response

idlong

typeenum

statusenum

Credit note lifecycle state. The same sync_payment_status! callback that derives invoice statuses also fires on credit notes (it’s on the base Document model), so the full payment-derived state set can appear here even though credit notes are not themselves a payment obligation. Practically: consumers should treat draft and exposed as the meaningful credit-note lifecycle states; the paid-family states reflect how the credit note has been applied against the source invoice’s payment allocation.

currencystring

ISO-4217 currency code.

created_atdatetime

updated_atdatetime

numberstring or null

Credit note number (formatted via number_series, e.g. ‘DOB2026-0001’). Null for drafts.

issue_datedate or null

delivery_datedate or null

exchange_ratestring or nullformat: "decimal"

included_in_turnoverboolean or null

reverse_chargeboolean or null

reverse_charge_textstring or null

discount_descriptionstring or null

discount_percentagestring or nullformat: "decimal"

discount_amountstring or nullformat: "decimal"

order_numberstring or null

text_openingstring or null

text_closingstring or null

footer_notestring or null

recipient_notestring or null

internal_notestring or null

pdf_languagestring or null

pdf_localestring or null

pdf_compact_modeboolean or null

hide_signatureboolean or null

delivery_typestring or null

sent_statusstring or null

email_sent_atdatetime or null

seen_timestampdatetime or null

purchaser_idlong or null

Party ID of the customer.

supplier_idlong or null

Party ID of the workspace's own legal entity.

bank_account_idlong or null

project_idlong or null

document_itemslist of objects

purchaserobject or null

supplierobject or null

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error