Retrieve a client invoice
Qonto APIs
- Introduction
- Using Qonto APIs
Business API
- Overview
- URLs
- Authentication
- Endpoints
- Attachments
- Attachments in Transactions
- Authentication
- Business Accounts
- Beneficiaries
- Cards
- Client Invoices
- Clients
- Credit Notes
- External Transfers
- Insurance Contracts
- Internal Transfers
- Labels
- Memberships
- Organizations
- Requests
- Statements
- Supplier Invoices
- Teams
- Transactions
- Webhooks
Onboarding API
- Overview
- Flows
- URLs
- Authentication
- Endpoints
- Webhooks
Qonto Embed Web SDK
- Overview
- Namespaces
- Types
Retrieve a client invoice
OAuth scope: client_invoices.read
Retrieves the client invoice identified by the id
path parameter.
GET
/
v2
/
client_invoices
/
{id}
curl --request GET \
--url https://thirdparty.qonto.com/v2/client_invoices/{id} \
--header 'Authorization: Bearer <token>'
{
"client_invoice": {
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"attachment_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"number": "INV001",
"purchase_order": "<string>",
"status": "paid",
"invoice_url": "https://pay.qonto.com/invoices/00000000-0000-0000-0000-000000000000",
"contact_email": "contact@qonto.com",
"terms_and_conditions": "This is an example.",
"discount_conditions": "Pas d’escompte accordé pour paiement anticipé.",
"late_payment_penalties": "En cas de non-paiement à la date d'échéance, des pénalités calculées à trois fois le taux d’intérêt légal seront appliquées.",
"legal_fixed_compensation": "Tout retard de paiement entraînera une indemnité forfaitaire pour frais de recouvrement de 40€.",
"header": "This is an example.",
"footer": "This is an example.",
"currency": "EUR",
"total_amount": {
"value": "12.52",
"currency": "EUR"
},
"total_amount_cents": 1252,
"vat_amount": {
"value": "0.51",
"currency": "EUR"
},
"vat_amount_cents": 51,
"issue_date": "2022-03-01",
"due_date": "2022-03-01",
"performance_date": "2022-03-01",
"created_at": "2022-03-04T17:58:30+02:00",
"finalized_at": "2022-03-04T17:58:30+02:00",
"paid_at": "2022-03-04T17:58:30+02:00",
"stamp_duty_amount": "1.00",
"items": [
{
"title": "Plastic tables",
"description": "Plastic tables for McDonald’s restaurants",
"quantity": "1.5",
"unit": "meter",
"unit_price": {
"value": "10.0",
"currency": "EUR"
},
"unit_price_cents": 1000,
"vat_rate": "0.1",
"vat_exemption_reason": "N1",
"discount": {
"type": "percentage",
"value": "0.1",
"amount": {
"value": "120",
"currency": "EUR"
}
},
"total_vat": {
"value": "120",
"currency": "EUR"
},
"total_vat_cents": 12000,
"total_amount": {
"value": "300.50",
"currency": "EUR"
},
"total_amount_cents": 30050,
"subtotal": {
"value": "120",
"currency": "EUR"
},
"subtotal_cents": 12000
}
],
"client": {
"id": "33v418bb-bd0d-4df4-865c-c07afab8bb48",
"name": "McDonald's",
"first_name": "Jane",
"last_name": "Doe",
"type": "individual",
"email": "client@qonto.com",
"vat_number": "FR32123456789",
"tax_identification_number": "123456789",
"address": "1 place de l’Opéra",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "fr",
"recipient_code": "<string>",
"locale": "fr",
"billing_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "FR"
},
"delivery_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "FR"
}
},
"payment_methods": [
{
"beneficiary_name": "John Doe",
"bic": "ABCDEFG1XXX",
"iban": "FR1420041010050500013M02606",
"type": "transfer"
}
],
"credit_notes_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_name": "<string>",
"legal_number": "<string>",
"legal_country": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_zipcode": "<string>",
"address_city": "<string>",
"address_country": "<string>",
"company_leadership": "Jan Mueller",
"district_court": "Munich",
"commercial_register_number": "HRB12345B",
"vat_number": "FR123456789",
"tax_number": "123/123/1234",
"legal_capital_share": {
"value": "10000.00",
"currency": "EUR"
},
"transaction_type": "goods",
"vat_payment_condition": "on_receipts"
},
"einvoicing_status": "pending",
"welfare_fund": {
"type": "TC01",
"rate": "0.0001"
},
"withholding_tax": {
"reason": "RF01",
"rate": "0.01",
"payment_reason": "L1",
"amount": "1.00"
},
"payment_reporting": {
"conditions": "TP01",
"method": "MP01"
}
}
}
Authorizations
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
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Path Parameters
UUID of the client invoice to retrieve.
Example:
"e3d68a1a-b23f-496a-a9a2-815089337720"
Response
200
application/json
Returns the client invoice identified by the `id` path parameter.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://thirdparty.qonto.com/v2/client_invoices/{id} \
--header 'Authorization: Bearer <token>'
{
"client_invoice": {
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"attachment_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"number": "INV001",
"purchase_order": "<string>",
"status": "paid",
"invoice_url": "https://pay.qonto.com/invoices/00000000-0000-0000-0000-000000000000",
"contact_email": "contact@qonto.com",
"terms_and_conditions": "This is an example.",
"discount_conditions": "Pas d’escompte accordé pour paiement anticipé.",
"late_payment_penalties": "En cas de non-paiement à la date d'échéance, des pénalités calculées à trois fois le taux d’intérêt légal seront appliquées.",
"legal_fixed_compensation": "Tout retard de paiement entraînera une indemnité forfaitaire pour frais de recouvrement de 40€.",
"header": "This is an example.",
"footer": "This is an example.",
"currency": "EUR",
"total_amount": {
"value": "12.52",
"currency": "EUR"
},
"total_amount_cents": 1252,
"vat_amount": {
"value": "0.51",
"currency": "EUR"
},
"vat_amount_cents": 51,
"issue_date": "2022-03-01",
"due_date": "2022-03-01",
"performance_date": "2022-03-01",
"created_at": "2022-03-04T17:58:30+02:00",
"finalized_at": "2022-03-04T17:58:30+02:00",
"paid_at": "2022-03-04T17:58:30+02:00",
"stamp_duty_amount": "1.00",
"items": [
{
"title": "Plastic tables",
"description": "Plastic tables for McDonald’s restaurants",
"quantity": "1.5",
"unit": "meter",
"unit_price": {
"value": "10.0",
"currency": "EUR"
},
"unit_price_cents": 1000,
"vat_rate": "0.1",
"vat_exemption_reason": "N1",
"discount": {
"type": "percentage",
"value": "0.1",
"amount": {
"value": "120",
"currency": "EUR"
}
},
"total_vat": {
"value": "120",
"currency": "EUR"
},
"total_vat_cents": 12000,
"total_amount": {
"value": "300.50",
"currency": "EUR"
},
"total_amount_cents": 30050,
"subtotal": {
"value": "120",
"currency": "EUR"
},
"subtotal_cents": 12000
}
],
"client": {
"id": "33v418bb-bd0d-4df4-865c-c07afab8bb48",
"name": "McDonald's",
"first_name": "Jane",
"last_name": "Doe",
"type": "individual",
"email": "client@qonto.com",
"vat_number": "FR32123456789",
"tax_identification_number": "123456789",
"address": "1 place de l’Opéra",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "fr",
"recipient_code": "<string>",
"locale": "fr",
"billing_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "FR"
},
"delivery_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"province_code": "<string>",
"country_code": "FR"
}
},
"payment_methods": [
{
"beneficiary_name": "John Doe",
"bic": "ABCDEFG1XXX",
"iban": "FR1420041010050500013M02606",
"type": "transfer"
}
],
"credit_notes_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_name": "<string>",
"legal_number": "<string>",
"legal_country": "<string>",
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_zipcode": "<string>",
"address_city": "<string>",
"address_country": "<string>",
"company_leadership": "Jan Mueller",
"district_court": "Munich",
"commercial_register_number": "HRB12345B",
"vat_number": "FR123456789",
"tax_number": "123/123/1234",
"legal_capital_share": {
"value": "10000.00",
"currency": "EUR"
},
"transaction_type": "goods",
"vat_payment_condition": "on_receipts"
},
"einvoicing_status": "pending",
"welfare_fund": {
"type": "TC01",
"rate": "0.0001"
},
"withholding_tax": {
"reason": "RF01",
"rate": "0.01",
"payment_reason": "L1",
"amount": "1.00"
},
"payment_reporting": {
"conditions": "TP01",
"method": "MP01"
}
}
}