Client Invoices
List client invoices
OAuth scope: client_invoices.read
Retrieves all client invoices for the authenticated organization.
Filtering
-
Invoices can be filtered by status. Note that the status can contain four possible values:
- draft the invoice was created but not validated. The invoice still needs to be validated to be paid.
- unpaid the invoice was created and validated. The invoice is ready to be paid.
- canceled the invoice was created but canceled by the initiator.The invoice it is not ready to be paid.
- paid the invoice was created, forwarded to the client, and successfully paid.
- Note that if the status is not specified in the query parameters, the response will contain invoices with all four mentioned statuses.
-
Invoices can be filtered by created date time interval using created_at_from and created_at_to where:
- created_at_from represents the min date
- created_at_to represents the max date
- Note that if the created_at_from and created_at_to are not specified in the query parameters, the response will contain all the invoices of that particular organization.
Sorting
- Invoices can be sorted by created_at
- Two values are available: asc (Ascending) / desc (Descending)
- By default, the order used to sort created_at is desc
Pagination
- The default number of items per page is 1, max items per page is 100. Pagination data is returned in the response : See Schema here.
get/v2/client_invoices
Query parameters
filter[status]'draft' | 'unpaid' | 'paid' | 'canceled'
Example:unpaid
filter[created_at_from]string date-time
Example:2022-02-01T12:01:02Z
filter[created_at_to]string date-time
Example:2022-23-04T16:23:00Z
pageinteger
Example:1
per_pageinteger
Example:25
sort_bystring
Example:created_at:desc
Headers
X-Qonto-Staging-Tokenstring
Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.
Response
Returns an array of client invoices.
Example response
{
"client_invoices": [
{
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"attachment_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"number": "INV001",
"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",
"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",
"country_code": "fr",
"locale": "fr",
"billing_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "FR"
},
"delivery_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "FR"
}
},
"payment_methods": [
{
"beneficiary_name": "John Doe",
"bic": "ABCDEFG1XXX",
"iban": "FR1420041010050500013M02606",
"type": "transfer"
}
],
"organization": {
"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"
},
"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"
}
}
],
"meta": {
"current_page": 2,
"prev_page": 1,
"total_pages": 2,
"total_count": 150,
"per_page": 100
}
}