API Reference
Start typing to search…

Create a credit note

post deprecatedhttps://app.pennylane.com/api/external/v2/credit_notes

This endpoint allows you to create a credit note

🚧

This endpoint is deprecated.

Please, use the Customer Invoices endpoint instead.
More details in this article

⚠️ ALPHA STATUS NOTICE

This endpoint is currently in alpha. It is part of an early testing phase, and its functionality may change or be removed in future updates.
We welcome your feedback to help us improve. Please use this endpoint with caution, especially in production environments, as backward compatibility is not guaranteed and functionality may change frequently.
This feature is best suited for developers interested in testing and providing input on upcoming capabilities.

ℹ️

This endpoint requires one of the following scopes: credit_notes:all

Log in to see full request history
Body Params
date
required

Credit note date (ISO 8601)

date
required

Credit note payment deadline (ISO 8601)

integer
required

Customer identifier

integer

The customer invoice template ID

integer

Invoice identifier of the invoice linked to the credit note

string | null

For example, the contact details of the person to contact

string | null

Credit note title

string | null

Credit note description

string

Credit note Currency (ISO 4217). Default is EUR.

string | null

Additional details.

string
Defaults to fr_FR
discount
object
transaction_reference
object

By adding this field you can automatically reconcile the newly created credit note with a transaction. See documentation about automatic payment matching.

invoice_line_sections
array of objects
invoice_line_sections
invoice_lines
array of objects
required
invoice_lines*
string

A unique external reference you can provide to track this credit note. If not provided, Pennylane will generate an identifier for you.

Responses

Response body
object
integer
required

Credit note identifier

object | null
required

The invoice linked to the credit note

integer
required
string
required

URL to get the credited invoice.

string | null
required
string
required
string
required
Defaults to EUR

EUR USD GBP AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL

string
required

Credit note amount (total value of the credit note in euros. If the currency is euro, currency_amount and amount are identical)

string
required

Credit note currency amount (total value of the credit note in the currency of the credit note)

string
required

Credit note currency amount before tax (total value before tax of the credit note in the currency of the credit note)

string
required

Credit note exchange rate (used to convert the credit note to euros. If the credit note currency is euro it will be 1.0)

date | null
required

Credit note issue date (ISO 8601)

string | null
required

Credit note payment deadline (ISO 8601)

string
required

Credit note taxable amount (in credit note currency)

string
required

Credit note taxable amount (in credit note currency)

string
required
Defaults to fr_FR

fr_FR en_GB

boolean
required

Credit note paid status (set to True if the credit note is paid)

discount
object
required
string
required

Discount type.

  • absolute if it is an amount
  • relative if it is a percentage

absolute relative

string | null
required

Discount value on the total amount before tax of the line

ledger_entry
object
required
integer
required

Ledger entry identifier

string | null
required

Public URL of the credit note file. The URL will expire after 30 minutes.

string | null
required

Name of the file attached to the credit note

string | null
required

The remaining amount with VAT to pay for the credit note to be considered paid

string | null
required

The remaining amount without VAT to pay for the credit note to be considered paid

string | null
required

Additional details

object | null
required
integer
required
string
required

URL to get the customer.

object | null
required
integer
required
object | null
required

This reconciles the credit note with a transaction. See documentation about automatic payment matching.

string
required

The banking provider for the transaction

string
required

Name of the field that you want to match

string
required

Value that you want to match

invoice_line_sections
object
required
string
required

URL to get the credit note line sections of the credit note.

invoice_lines
object
required
string
required

URL to get the credit note lines.

categories
object
required
string
required

URL to get the categories.

string
required
string
required
string | null
required
string
required

The unique external reference that was assigned during creation either by you or Pennylane. (Same attribute as external_id in the API v1)

date-time | null
required

The time the credit note has been archived

date-time
required

The time the credit note has been created

date-time
required

The last time the credit note has been updated

Updated 5 days ago

Language
Credentials
OAuth2

Updated 5 days ago