PUT
/
api
/
external
/
v2
/
credit_notes
/
{id}
/
update_finalized
{
  "amount": "-230.32",
  "archived_at": "2023-08-30T10:08:08.146343Z",
  "categories": {
    "url": "https://app.pennylane.com/api/external/v2/credit_notes/42/categories"
  },
  "created_at": "2023-08-30T10:08:08.146343Z",
  "credited_invoice": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42"
  },
  "currency": "EUR",
  "currency_amount": "-230.32",
  "currency_amount_before_tax": "-196.32",
  "currency_tax": "-34.0",
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customers/42"
  },
  "customer_invoice_template": {
    "id": 45973416
  },
  "date": "2023-08-30",
  "deadline": "2020-09-02",
  "discount": {
    "type": "relative",
    "value": "aliquip"
  },
  "exchange_rate": "1.0",
  "external_reference": "FR123",
  "filename": "my_file.pdf",
  "id": 42,
  "invoice_line_sections": {
    "url": "https://app.pennylane.com/api/external/v2/credit_notes/42/invoice_line_sections"
  },
  "invoice_lines": {
    "url": "https://app.pennylane.com/api/external/v2/credit_notes/42/invoice_lines"
  },
  "invoice_number": "F20230001",
  "label": "Credit note label",
  "language": "fr_FR",
  "ledger_entry": {
    "id": 42002
  },
  "paid": false,
  "pdf_description": "Credit note description",
  "pdf_invoice_free_text": "Thanks for paying this credit note",
  "pdf_invoice_subject": "Credit note subject",
  "public_file_url": "https://app.pennylane.com/public/invoice/pdf?encrypted_id=bzjoVJe...3D%3D",
  "remaining_amount_with_tax": "20.0",
  "remaining_amount_without_tax": "16.0",
  "special_mention": "Additional details",
  "tax": "-34.0",
  "transaction_reference": {
    "banking_provider": "stripe",
    "provider_field_name": "label",
    "provider_field_value": "invoice_number"
  },
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Path Parameters

​
id
string
required

(Required)

Example:

"42"

Body

application/json

Response

200
application/json

A Credit note

The response is of type object.