Search suppliers
curl --request POST \
--url https://thirdparty.qonto.com/v2/suppliers/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"search": "acme",
"statuses": [],
"ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"sort": {
"field": "name",
"direction": "asc"
},
"pagination": {
"page": 1,
"per_page": 25
}
}
'import requests
url = "https://thirdparty.qonto.com/v2/suppliers/search"
payload = {
"filter": {
"search": "acme",
"statuses": [],
"ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"sort": {
"field": "name",
"direction": "asc"
},
"pagination": {
"page": 1,
"per_page": 25
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {search: 'acme', statuses: [], ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
sort: {field: 'name', direction: 'asc'},
pagination: {page: 1, per_page: 25}
})
};
fetch('https://thirdparty.qonto.com/v2/suppliers/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://thirdparty.qonto.com/v2/suppliers/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'search' => 'acme',
'statuses' => [
],
'ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sort' => [
'field' => 'name',
'direction' => 'asc'
],
'pagination' => [
'page' => 1,
'per_page' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://thirdparty.qonto.com/v2/suppliers/search"
payload := strings.NewReader("{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://thirdparty.qonto.com/v2/suppliers/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://thirdparty.qonto.com/v2/suppliers/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"suppliers": [
{
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "0f0cff65-bbc0-4a8b-887d-bb7ca8ad2614",
"name": "ACME",
"status": "unarchived",
"currency": "EUR",
"default_vat_rate": 20,
"outstanding_balance": {
"value": "22.10",
"currency": "EUR"
},
"tax_identifiers": {
"tin_number": "123456789",
"vat_number": "FR1234567"
},
"address": {
"street_address": "<string>",
"zip_code": "<string>",
"province_code": "<string>",
"city": "<string>",
"country_code": "FR"
},
"contact_info": {
"email": "<string>",
"phone_number": "<string>"
},
"e_invoicing": {
"recipient_code": "<string>"
},
"payment_details": {
"iban": "FR7630006000011234567890189"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_pages": 11,
"total_count": 210,
"per_page": 20
}
}Suppliers
Search suppliers
OAuth scope: supplier_invoice.read
Searches the organization’s suppliers. All filters are optional; with an empty body, unarchived suppliers are returned sorted by name, 25 per page.
Sensitive fields (payment_details.iban, tax_identifiers) are masked unless the caller holds the permission to see sensitive supplier fields. outstanding_balance is only returned to callers with access to supplier invoice insights.
POST
/
v2
/
suppliers
/
search
Search suppliers
curl --request POST \
--url https://thirdparty.qonto.com/v2/suppliers/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"search": "acme",
"statuses": [],
"ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"sort": {
"field": "name",
"direction": "asc"
},
"pagination": {
"page": 1,
"per_page": 25
}
}
'import requests
url = "https://thirdparty.qonto.com/v2/suppliers/search"
payload = {
"filter": {
"search": "acme",
"statuses": [],
"ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"sort": {
"field": "name",
"direction": "asc"
},
"pagination": {
"page": 1,
"per_page": 25
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {search: 'acme', statuses: [], ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
sort: {field: 'name', direction: 'asc'},
pagination: {page: 1, per_page: 25}
})
};
fetch('https://thirdparty.qonto.com/v2/suppliers/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://thirdparty.qonto.com/v2/suppliers/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'search' => 'acme',
'statuses' => [
],
'ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sort' => [
'field' => 'name',
'direction' => 'asc'
],
'pagination' => [
'page' => 1,
'per_page' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://thirdparty.qonto.com/v2/suppliers/search"
payload := strings.NewReader("{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://thirdparty.qonto.com/v2/suppliers/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://thirdparty.qonto.com/v2/suppliers/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"search\": \"acme\",\n \"statuses\": [],\n \"ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"sort\": {\n \"field\": \"name\",\n \"direction\": \"asc\"\n },\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"suppliers": [
{
"id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
"organization_id": "0f0cff65-bbc0-4a8b-887d-bb7ca8ad2614",
"name": "ACME",
"status": "unarchived",
"currency": "EUR",
"default_vat_rate": 20,
"outstanding_balance": {
"value": "22.10",
"currency": "EUR"
},
"tax_identifiers": {
"tin_number": "123456789",
"vat_number": "FR1234567"
},
"address": {
"street_address": "<string>",
"zip_code": "<string>",
"province_code": "<string>",
"city": "<string>",
"country_code": "FR"
},
"contact_info": {
"email": "<string>",
"phone_number": "<string>"
},
"e_invoicing": {
"recipient_code": "<string>"
},
"payment_details": {
"iban": "FR7630006000011234567890189"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_pages": 11,
"total_count": 210,
"per_page": 20
}
}Authorizations
OAuthSecretKey
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.
FlowAuthorization Code
- Authorization URL
- https://oauth.qonto.com/oauth2/auth
- Token URL
- https://oauth.qonto.com/oauth2/token
- Refresh URL
- https://oauth.qonto.com/oauth2/token
Scopes1
supplier_invoice.read
Retrieve supplier invoices
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Body
application/json
Was this page helpful?