Get a list of supplier invoices for an organization
OAuth scope: supplier_invoice.read
Price plans: this endpoint is available for all Qonto price plans except Solo basic.
List all supplier invoices for an organization
Attributes details
Initiator
initiator_id is the member who uploaded the invoice.
Statuses
status contains four possible values:
- to_review: When first uploaded, the invoice lands in this state for review.
- to_pay: Deprecated: This status will no longer be assigned to new supplier-invoices. Any invoices already in the to_pay status can be marked as paid or be scheduled for transfer.
- pending: The invoice is waiting for approval or declining by one of the authorized members (only accessible by organizations in a Business or Enterprise plan).
- scheduled: The invoice is scheduled to be paid. This status is managed by Qonto as it tracks the updates of the transfer.
- paid: The invoice is paid.
Filters
status
Supplier invoices can be filter by available status.
created_at_from and created_at_to
Supplier 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
Supplier invoices can be sorted by a specific field and order. The sort_by query parameter accepts a string defining these two items with the field:order format.
Field
created_at, file_name, supplier_name, payment_date, due_date, scheduled_date and total_amount values are available. By default the field used to sort invoices is created_at:desc for the To Review section and payment_date:asc for the To Pay and Processed payment_date:desc
Order
Two values are available : asc (Ascending) / desc (Descending) By default the order used to sort supplier invoices is desc
Pagination
Default number of items per page is 1, max items per page is 100. Pagination data is returned in the response : See Schema here.
Query parameters
status to filter on
RFC3339 format (e.g 2022-01-21T12:01:02Z)
RFC3339 format (e.g 2022-01-21T12:01:02Z)
Headers
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 supplier invoices
Example response
{
"supplier_invoices": [
{
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"file_name": "my-invoice.pdf",
"invoice_number": "QONTO-JAN-2022",
"supplier_name": "McDonald's",
"description": "This is an invoice for Ronald!",
"total_amount": {
"value": "22.10",
"currency": "EUR"
},
"issue_date": "2022-02-01",
"due_date": "2022-03-01",
"payment_date": "2022-03-01",
"scheduled_date": "2022-03-01",
"status": "to_review",
"iban": "FR1420041010050500013M02606",
"source_type": "email",
"created_at": "2022-03-04T17:58:30+02:00",
"updated_at": "2022-03-04T17:58:30+02:00",
"analyzed_at": "2022-03-04T17:58:30+02:00",
"request_transfer": {
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"initiator_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
},
"meta": {
"integration_type": "amazon",
"connector": "grover"
}
}
],
"meta": {
"current_page": 2,
"prev_page": 1,
"total_pages": 2,
"total_count": 150,
"per_page": 100
}
}