Retrieve a supplier invoice

curl --request GET \
  --url https://thirdparty.qonto.com/v2/supplier_invoices/{id} \
  --header 'Authorization: Bearer <token>'

{
  "supplier_invoice": {
    "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
    "is_einvoice": false,
    "has_discrepancies": false,
    "organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
    "file_name": "my-invoice.pdf",
    "status": "to_review",
    "source_type": "email",
    "created_at": "2022-03-04T17:58:30+02:00",
    "updated_at": "2022-03-04T17:58:30+02:00",
    "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "declined_note": "",
    "e_invoice_type": "zugferd",
    "has_duplicates": false,
    "invoice_number": "QONTO-JAN-2022",
    "supplier_name": "McDonald's",
    "vat_number": "IT12345678901",
    "tin": "1234567890",
    "description": "This is an invoice for Ronald!",
    "total_amount": {
      "value": "22.10",
      "currency": "EUR"
    },
    "issue_date": "2022-03-01",
    "due_date": "2022-03-01",
    "payment_date": "2022-03-01",
    "scheduled_date": "2022-03-01",
    "iban": "FR1420041010050500013M02606",
    "initiator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "email_forward",
    "is_attachment_invoice": true,
    "attachment_category": "INVOICE",
    "is_attachment_non_financial": true,
    "analyzed_at": "2022-03-04T17:58:30+02:00",
    "matched_transactions": [
      "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    ],
    "transfer_ids": [
      "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    ],
    "request_transfer": {
      "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
      "initiator_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    },
    "einvoicing_lifecycle_events": [
      {
        "status_code": 200,
        "reason": "DOUBLE FACTURE",
        "reason_message": "I already received this invoice",
        "timestamp": "2024-12-04T11:05:16.4497Z"
      }
    ],
    "meta": {
      "integration_type": "amazon",
      "connector": "grover",
      "accounting_recorded_at": "2023-11-07T05:31:56Z",
      "accounting_recorded_source": "regate"
    },
    "available_actions": {
      "delete": true,
      "archive": true,
      "unarchive": true,
      "pay": true,
      "reasons": {
        "pay": [
          "is_credit_note"
        ],
        "delete": [
          "invalid_status"
        ],
        "archive": [
          "invalid_status"
        ],
        "unarchive": [
          "invalid_status"
        ]
      }
    },
    "approval_workflow": {
      "approver_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "supplier_invoice_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "verified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "payable_amount": {
      "value": "22.10",
      "currency": "EUR"
    },
    "total_amount_credit_notes": {
      "value": "22.10",
      "currency": "EUR"
    },
    "is_credit_note": false,
    "has_suggested_credit_notes": false,
    "related_invoices": [
      {
        "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
        "invoice_number": "QONTO-JAN-2022",
        "total_amount": {
          "value": "22.10",
          "currency": "EUR"
        },
        "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "my-invoice.pdf"
      }
    ],
    "suggested_transactions": [
      {
        "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
        "score": "0.8"
      }
    ]
  }
}

GET

supplier_invoices

{id}

Retrieve a supplier invoice

curl --request GET \
  --url https://thirdparty.qonto.com/v2/supplier_invoices/{id} \
  --header 'Authorization: Bearer <token>'

{
  "supplier_invoice": {
    "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
    "is_einvoice": false,
    "has_discrepancies": false,
    "organization_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
    "file_name": "my-invoice.pdf",
    "status": "to_review",
    "source_type": "email",
    "created_at": "2022-03-04T17:58:30+02:00",
    "updated_at": "2022-03-04T17:58:30+02:00",
    "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "declined_note": "",
    "e_invoice_type": "zugferd",
    "has_duplicates": false,
    "invoice_number": "QONTO-JAN-2022",
    "supplier_name": "McDonald's",
    "vat_number": "IT12345678901",
    "tin": "1234567890",
    "description": "This is an invoice for Ronald!",
    "total_amount": {
      "value": "22.10",
      "currency": "EUR"
    },
    "issue_date": "2022-03-01",
    "due_date": "2022-03-01",
    "payment_date": "2022-03-01",
    "scheduled_date": "2022-03-01",
    "iban": "FR1420041010050500013M02606",
    "initiator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "email_forward",
    "is_attachment_invoice": true,
    "attachment_category": "INVOICE",
    "is_attachment_non_financial": true,
    "analyzed_at": "2022-03-04T17:58:30+02:00",
    "matched_transactions": [
      "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    ],
    "transfer_ids": [
      "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    ],
    "request_transfer": {
      "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
      "initiator_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48"
    },
    "einvoicing_lifecycle_events": [
      {
        "status_code": 200,
        "reason": "DOUBLE FACTURE",
        "reason_message": "I already received this invoice",
        "timestamp": "2024-12-04T11:05:16.4497Z"
      }
    ],
    "meta": {
      "integration_type": "amazon",
      "connector": "grover",
      "accounting_recorded_at": "2023-11-07T05:31:56Z",
      "accounting_recorded_source": "regate"
    },
    "available_actions": {
      "delete": true,
      "archive": true,
      "unarchive": true,
      "pay": true,
      "reasons": {
        "pay": [
          "is_credit_note"
        ],
        "delete": [
          "invalid_status"
        ],
        "archive": [
          "invalid_status"
        ],
        "unarchive": [
          "invalid_status"
        ]
      }
    },
    "approval_workflow": {
      "approver_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "supplier_invoice_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "verified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "payable_amount": {
      "value": "22.10",
      "currency": "EUR"
    },
    "total_amount_credit_notes": {
      "value": "22.10",
      "currency": "EUR"
    },
    "is_credit_note": false,
    "has_suggested_credit_notes": false,
    "related_invoices": [
      {
        "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
        "invoice_number": "QONTO-JAN-2022",
        "total_amount": {
          "value": "22.10",
          "currency": "EUR"
        },
        "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "my-invoice.pdf"
      }
    ],
    "suggested_transactions": [
      {
        "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
        "score": "0.8"
      }
    ]
  }
}

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

Example:

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

Response

Returns the supplier invoice identified by the id path parameter.

supplier_invoice

object

required

Show child attributes

supplier_invoice.id

string<uuid>

required

Example:

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

supplier_invoice.is_einvoice

boolean

required

indicates if the invoice is an e-invoice, currently ONLY for the German organizations

Example:

false

supplier_invoice.has_discrepancies

boolean

required

Example:

false

supplier_invoice.organization_id

string<uuid>

required

Example:

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

supplier_invoice.file_name

string

required

Example:

"my-invoice.pdf"

supplier_invoice.status

required

Initial status for invoices.

Allowed value: "to_review"

Example:

"to_review"

supplier_invoice.source_type

enum<string>

required

Available options:

email,

e_invoicing,

direct_upload

Example:

"email"

supplier_invoice.created_at

string

required

Example:

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

supplier_invoice.updated_at

string

required

Example:

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

supplier_invoice.attachment_id

string<uuid>

required

supplier_invoice.display_attachment_id

string<uuid>

required

supplier_invoice.declined_note

string

default:""

required

Note specified when invoice was archived

supplier_invoice.e_invoice_type

enum<string>

Available options:

zugferd,

xrechnung

Example:

"zugferd"

supplier_invoice.has_duplicates

boolean

Example:

false

supplier_invoice.invoice_number

string

Example:

"QONTO-JAN-2022"

supplier_invoice.supplier_name

string

Example:

"McDonald's"

supplier_invoice.vat_number

string | null

VAT number of the invoice issuer

Example:

"IT12345678901"

supplier_invoice.tin

string | null

Tax Identification Number (TIN) of the invoice issuer

Example:

"1234567890"

supplier_invoice.description

string

Example:

"This is an invoice for Ronald!"

supplier_invoice.total_amount

object

Show child attributes

supplier_invoice.total_amount.value

string

Example:

"22.10"

supplier_invoice.total_amount.currency

string

Example:

"EUR"

supplier_invoice.issue_date

string

Example:

"2022-03-01"

supplier_invoice.due_date

string

Example:

"2022-03-01"

supplier_invoice.payment_date

string

Example:

"2022-03-01"

supplier_invoice.scheduled_date

string

Example:

"2022-03-01"

supplier_invoice.iban

string

Example:

"FR1420041010050500013M02606"

supplier_invoice.initiator_id

string<uuid>

supplier_invoice.source

enum<string>

Available options:

email_forward,

e_invoicing,

supplier_invoices,

pay_by_invoice,

integration,

regate,

generic_upload,

pay_later

Example:

"email_forward"

supplier_invoice.is_attachment_invoice

boolean

supplier_invoice.attachment_category

enum<string>

The category of the attachment

Available options:

INVOICE,

EXPENSE_RECEIPT,

CARD_RECEIPT,

CREDIT_CARD_RECEIPT,

CREDIT_NOTE,

OTHER_FINANCIAL_DOCUMENT,

OTHER_NON_FINANCIAL_DOCUMENT,

UNKNOWN

Example:

"INVOICE"

supplier_invoice.is_attachment_non_financial

boolean

supplier_invoice.analyzed_at

string

Example:

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

supplier_invoice.matched_transactions

string<uuid>[]

supplier_invoice.transfer_ids

string<uuid>[] | null

IDs of the transfer payments associated with this invoice, if any

supplier_invoice.request_transfer

object

Show child attributes

supplier_invoice.request_transfer.id

string<uuid>

Example:

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

supplier_invoice.request_transfer.initiator_id

string<uuid>

Example:

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

supplier_invoice.einvoicing_lifecycle_events

object[]

Show child attributes

supplier_invoice.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

supplier_invoice.einvoicing_lifecycle_events.reason

string

The reason label associated with a given event

Example:

"DOUBLE FACTURE"

supplier_invoice.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"

supplier_invoice.einvoicing_lifecycle_events.timestamp

string<date-time>

The timestamp of the event

Example:

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

supplier_invoice.meta

object

Show child attributes

supplier_invoice.meta.integration_type

string

Example:

"amazon"

supplier_invoice.meta.connector

string

Example:

"grover"

supplier_invoice.meta.accounting_recorded_at

string<date-time>

supplier_invoice.meta.accounting_recorded_source

string

Example:

"regate"

supplier_invoice.available_actions

object

Available actions for the invoice

Show child attributes

supplier_invoice.available_actions.delete

boolean

Indicates if the invoice can be deleted

supplier_invoice.available_actions.archive

boolean

Indicates if the invoice can be archived

supplier_invoice.available_actions.unarchive

boolean

Indicates if the invoice can be unarchived

supplier_invoice.available_actions.pay

boolean

Indicates if the invoice can be paid

supplier_invoice.available_actions.reasons

object

Detailed reasons for why certain actions are not available

Show child attributes

supplier_invoice.available_actions.reasons.pay

enum<string>[]

List of reasons why the invoice cannot be paid

Available options:

is_credit_note,

missing_iban,

missing_data,

invalid_status,

incorrect_approval_workflow

supplier_invoice.available_actions.reasons.delete

enum<string>[]

List of reasons why the invoice cannot be deleted

Available options:

invalid_status,

linked_self_invoice,

is_recorded

supplier_invoice.available_actions.reasons.archive

enum<string>[]

List of reasons why the invoice cannot be archived

Available options:

invalid_status

supplier_invoice.available_actions.reasons.unarchive

enum<string>[]

List of reasons why the invoice cannot be unarchived

Available options:

invalid_status

supplier_invoice.approval_workflow

object

Show child attributes

supplier_invoice.approval_workflow.approver_ids

string<uuid>[]

required

Membership IDs of the users who are next in line to approve the invoice

supplier_invoice.approval_workflow.supplier_invoice_request_id

string<uuid> | null

required

supplier_invoice.approval_workflow.verified_by

string<uuid> | null

required

ID of the membership that verified the supplier invoice and send it to approval workflow

supplier_invoice.approval_workflow.last_approved_by

string<uuid> | null

required

ID of the last membership that approved the supplier invoice request

supplier_invoice.payable_amount

object

Show child attributes

supplier_invoice.payable_amount.value

string

Example:

"22.10"

supplier_invoice.payable_amount.currency

string

Example:

"EUR"

supplier_invoice.total_amount_credit_notes

object

Show child attributes

supplier_invoice.total_amount_credit_notes.value

string

Example:

"22.10"

supplier_invoice.total_amount_credit_notes.currency

string

Example:

"EUR"

supplier_invoice.is_credit_note

boolean

Example:

false

supplier_invoice.has_suggested_credit_notes

boolean

Example:

false

Show child attributes

Example:

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

Example:

"QONTO-JAN-2022"

Show child attributes

Example:

"22.10"

Example:

"EUR"

Example:

"my-invoice.pdf"

supplier_invoice.suggested_transactions

object[] | null

suggested transactions for the invoice

Show child attributes

supplier_invoice.suggested_transactions.id

string<uuid>

id of the suggested transaction

Example:

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

supplier_invoice.suggested_transactions.score

string

match confidence score

Example:

"0.8"

Create supplier invoices Get e-invoicing settings

⌘I

Business API

Onboarding API

Retrieve a supplier invoice

Authorizations

Headers

Path Parameters

Response