Retrieve a credit note

Authorizations

Authorization

string

header

required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token

string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Path Parameters

string<uuid>

required

ID of the credit note

Response

Returns the credit note identified by the id path parameter.

credit_note

object

required

Show child attributes

credit_note.id

string<uuid>

Example:

"4d5418bb-bd0d-4df4-865c-c07afab8bb48"

credit_note.invoice_id

string<uuid>

Invoice id the credit note is linked to.

Example:

"4d5418bb-bd0d-4df4-865c-c07afab8bb48"

credit_note.attachment_id

string<uuid>

Attachment UUID corresponding to that particular credit note. You can obtain details and get the credit note by using Get attachment.

Example:

"4d5418bb-bd0d-4df4-865c-c07afab8bb48"

credit_note.issue_date

string<date>

Date the initiator mentioned that the credit note was created.

Example:

"2022-03-01"

credit_note.invoice_issue_date

string<date>

Issue date of the invoice identified by invoice_id.

Example:

"2022-03-02"

credit_note.number

string

Example:

"INV001"

credit_note.terms_and_conditions

string

T&C data added by the credit note’s initiator.

Example:

"This is an example."

credit_note.header

string

Header text added by the credit note’s initiator.

Example:

"This is an example."

credit_note.footer

string

Footer text added by the credit note’s initiator.

Example:

"This is an example."

credit_note.vat_amount

object

Show child attributes

credit_note.vat_amount.value

string

Example:

"0.51"

credit_note.vat_amount.currency

string

Example:

"EUR"

credit_note.vat_amount_cents

integer

Example:

51

credit_note.total_amount

object

Show child attributes

credit_note.total_amount.value

string

Example:

"12.52"

credit_note.total_amount.currency

string

Example:

"EUR"

credit_note.total_amount_cents

integer

Example:

1252

credit_note.currency

string

Example:

"EUR"

credit_note.created_at

string<date-time>

Date the credit note was created. Note that this is a machine date.

Example:

"2022-03-04T17:58:30+02:00"

credit_note.finalized_at

string<date-time>

Example:

"2022-03-04T17:58:30+02:00"

credit_note.contact_email

string<email>

E-mail address of the credit note’s initiator.

Example:

"[email protected]"

credit_note.invoice_url

string<uri>

URL of the invoice public page, accessible without authentication for 180 days after issuance, provided the invoice has not been canceled.

Example:

"https://pay.qonto.com/invoices/00000000-0000-0000-0000-000000000000"

credit_note.einvoicing_status

enum<string>

Available options:

pending,

submitted,

declined,

approved,

not_delivered,

submission_failed

credit_note.welfare_fund

object

Show child attributes

credit_note.welfare_fund.type

enum<string>

Available options:

TC01,

TC02,

TC03,

TC04,

TC05,

TC06,

TC07,

TC08,

TC09,

TC10,

TC11,

TC12,

TC13,

TC14,

TC15,

TC16,

TC17,

TC18,

TC19,

TC20,

TC21,

TC22

Example:

"TC01"

credit_note.welfare_fund.rate

string

Required string length: 4 - 6

Example:

"0.0001"

credit_note.withholding_tax

object

Only applicable for Italian organizations and Spanish freelancers.
Object which relates to an amount of tax paid by the client, rather than the supplier, for specific cases.
This amount is a percentage deducted from the total amount of the invoice after VAT application.
The rate field specifies the percentage of tax and amount field specifies the total amount of the tax.

Show child attributes

credit_note.withholding_tax.reason

enum<string>

Available options:

RF01,

RF02,

RF03,

RF04,

RF05,

RF06

Example:

"RF01"

credit_note.withholding_tax.rate

string

Required string length: 4 - 6

Example:

"0.01"

credit_note.withholding_tax.payment_reason

string

Required string length: 1 - 2

credit_note.withholding_tax.amount

string

Example:

"1.00"

credit_note.stamp_duty_amount

string

Required string length: 4 - 15

Example:

"1.00"

credit_note.items

object[]

Show child attributes

credit_note.items.title

string

Example:

"Plastic tables"

credit_note.items.description

string

Example:

"Plastic tables for McDonald’s restaurants"

credit_note.items.quantity

string

Example:

"1.5"

credit_note.items.unit

string

Example:

"meter"

credit_note.items.unit_price

object

Amount of the price per unit. Note that an item can contain multiple units. The number of units is defined via quantity.

Show child attributes

credit_note.items.unit_price.value

string

Example:

"10.0"

credit_note.items.unit_price.currency

string

Example:

"EUR"

credit_note.items.unit_price_cents

integer

Amount in cents of the price per unit. Note that an item can contain multiple units. The number of units is defined via quantity.

Example:

1000

credit_note.items.vat_rate

string

VAT rate in decimal (0.1 for 10%) applicable to that particular item.

Example:

"0.1"

credit_note.items.vat_exemption_reason

enum<string>

Exemption reason

Available options:

N1,

N2,

N2.1,

N2.2,

N3,

N3.1,

N3.2,

N3.3,

N3.4,

N3.5,

N3.6,

N4,

N5,

N6,

N6.1,

N6.2,

N6.3,

N6.4,

N6.5,

N6.6,

N6.7,

N6.8,

N6.9,

N7,

S293B,

S262.1,

S259,

S283,

S261,

S262,

S263,

S19.1,

S4.1B,

S4.1A,

S4,

S13B,

S122,

S25,

S21,

S69,

S20,

S84.1.2

credit_note.items.discount

object

Show child attributes

credit_note.items.discount.type

enum<string>

Available options:

percentage,

absolute

Example:

"percentage"

credit_note.items.discount.value

string

Discount rate or absolute amount. For percentage, the minimum value is 0.0001 (0.01%), and the maximum value is 1 (100%). For absolute value, the maximum is determined by Quantity * Unit Price.

Example:

"0.1"

credit_note.items.discount.amount

object

Show child attributes

credit_note.items.discount.amount.value

string

Example:

"120"

credit_note.items.discount.amount.currency

string

Example:

"EUR"

credit_note.items.total_vat

object

VAT amount that is applicable to that specific item.

Show child attributes

credit_note.items.total_vat.value

string

Example:

"120"

credit_note.items.total_vat.currency

string

Example:

"EUR"

credit_note.items.total_vat_cents

integer

VAT amount in cents that is applicable to that specific item.

Example:

12000

credit_note.items.total_amount

object

Amount that needs to be paid by the client for that specific item.

Show child attributes

credit_note.items.total_amount.value

string

Example:

"300.50"

credit_note.items.total_amount.currency

string

Example:

"EUR"

credit_note.items.total_amount_cents

integer

Amount in cents that needs to be paid by the client for that specific item.

Example:

30050

credit_note.items.subtotal

object

Show child attributes

credit_note.items.subtotal.value

string

Subtotal amount for the item without VAT. Quantity * Unit_price.

Example:

"120"

credit_note.items.subtotal.currency

string

Example:

"EUR"

credit_note.items.subtotal_cents

integer

Subtotal amount in cents for the item without VAT.

Example:

12000

credit_note.client

object

Client that needs to pay the invoice.

Show child attributes

credit_note.client.id

string<uuid>

Example:

"33v418bb-bd0d-4df4-865c-c07afab8bb48"

credit_note.client.name

string

Note that this property will be returned only if the client is a company.

Example:

"McDonald's"

credit_note.client.first_name

string

Note that this property will be returned only if the client is an individual or a freelancer.

Example:

"Jane"

credit_note.client.last_name

string

Note that this property will be returned only if the client is an individual or a freelancer.

Example:

"Doe"

credit_note.client.type

enum<string>

Available options:

individual,

company,

freelancer

Example:

"individual"

credit_note.client.email

string<email>

Example:

"[email protected]"

credit_note.client.vat_number

string

Example:

"FR32123456789"

credit_note.client.tax_identification_number

string

Example:

"123456789"

credit_note.client.address

string

Example:

"1 place de l’Opéra"

credit_note.client.city

string

Example:

"Paris"

credit_note.client.zip_code

string

Example:

"75009"

credit_note.client.province_code

string

Province code of the client. It is required only for Italian organizations

credit_note.client.country_code

string

Example:

"fr"

credit_note.client.recipient_code

string

Recipient code, so that the client can receive the e-invoice in his SdI portal.

credit_note.client.locale

string

Example:

"fr"

credit_note.client.billing_address

object

Billing address of the client, which will be reflected on the invoice. Stores the same data as the root-level fields address fields (address, city, zip_code, province_code, country_code). Send either a billing_address object filled-in or individual root-level address fields (address, city, zip_code, province_code, country_code). When both are sent, billing_address takes precedence and overwrites root-level fields.

Show child attributes

credit_note.client.billing_address.street_address

string

Street address section of the billing address of the client (eg street, number, floor, door, etc).

Maximum string length: 250

Example:

"123 Main Street"

credit_note.client.billing_address.city

string

City on the billing address of the client

Maximum string length: 50

Example:

"Paris"

credit_note.client.billing_address.zip_code

string

Zip code on the billing address of the client

Maximum string length: 20

Example:

"75009"

credit_note.client.billing_address.province_code

string

Province code of the client's billing address. It is required only for Italian organizations.

Maximum string length: 2

credit_note.client.billing_address.country_code

string

Country code on the billing address of the client (ISO 3166 format)

Maximum string length: 2

Example:

"FR"

credit_note.client.delivery_address

object

Delivery address of the client. Stores the same data as the root-level fields address fields (address, city, zip_code, province_code, country_code).

Show child attributes

credit_note.client.delivery_address.street_address

string

Street address section of the delivery address of the client. (eg street, number, floor, door, etc)

Maximum string length: 250

Example:

"123 Main Street"

credit_note.client.delivery_address.city

string

City on the delivery address of the client

Maximum string length: 50

Example:

"Paris"

credit_note.client.delivery_address.zip_code

string

Zip code on the delivery address of the client

Maximum string length: 20

Example:

"75009"

credit_note.client.delivery_address.province_code

string

Province code of the client's delivery address. It is required only for Italian organizations

Maximum string length: 2

credit_note.client.delivery_address.country_code

string

Country code on the delivery address of the client (ISO 3166 format)

Maximum string length: 2

Example:

"FR"

credit_note.einvoicing_lifecycle_events

object[]

Array of lifecycle events related to the e-invoicing process

Show child attributes

credit_note.einvoicing_lifecycle_events.status_code

enum<integer>

Status code of the operation. - 200: Déposée (Submitted) - 201: Emise par la plateforme (Issued by the platform) - 202: Reçue de la plateforme (Received from the platform) - 203: Mise à disposition (Made available) - 204: Prise en charge (Taken over) - 205: Approuvée (Approved) - 206: Approuvée partiellement (Partially approved) - 207: En litige (In dispute) - 208: Suspendue (Suspended) - 209: Complétée (Completed) - 210: Refusée (Refused) - 211: Paiement transmis (Payment sent) - 212: Encaissée (Collected) - 213: Rejetée (Rejected) - 214: Visée (Vised)

Available options:

200,

201,

202,

203,

204,

205,

206,

207,

208,

209,

210,

211,

212,

213,

214

Example:

200

credit_note.einvoicing_lifecycle_events.reason

string

The reason label associated with a given event

Example:

"DOUBLE FACTURE"

credit_note.einvoicing_lifecycle_events.reason_message

string

The reason message associated with a given event (comment provided by the user generating the event)

Example:

"I already received this invoice"

credit_note.einvoicing_lifecycle_events.timestamp

string<date-time>

The timestamp of the event

Example:

"2024-12-04T11:05:16.4497Z"

Business API

Onboarding API

Retrieve a credit note

Authorizations

Headers

Path Parameters

Response