GET
/
api
/
external
/
v2
/
suppliers
{
  "has_more": true,
  "items": [
    {
      "created_at": "2023-08-30T10:08:08.146343Z",
      "emails": [
        "hello@example.org"
      ],
      "establishment_no": "82762938500014",
      "external_reference": "FR123",
      "iban": "FRXXXXXXXXXXXXXXXXXXXXXXXXX",
      "id": 42,
      "ledger_account": {
        "id": 38969920
      },
      "name": "Pennylane",
      "postal_address": {
        "address": "Lorem adipisicing",
        "city": "proident",
        "country_alpha2": "in minim ad culpa in",
        "postal_code": "in velit ut deserunt"
      },
      "supplier_due_date_delay": 30,
      "supplier_due_date_rule": "days",
      "supplier_payment_method": "check",
      "updated_at": "2023-08-30T10:08:08.146343Z",
      "vat_number": "FR32123456789"
    },
    {
      "created_at": "2023-08-30T10:08:08.146343Z",
      "emails": [
        "hello@example.org"
      ],
      "establishment_no": "82762938500014",
      "external_reference": "FR123",
      "iban": "FRXXXXXXXXXXXXXXXXXXXXXXXXX",
      "id": 42,
      "ledger_account": {
        "id": 54515813
      },
      "name": "Pennylane",
      "postal_address": {
        "address": "adipisicing et eiusmod",
        "city": "ipsum proident nostrud",
        "country_alpha2": "ea ut occaecat quis",
        "postal_code": "pariatur nisi magna"
      },
      "supplier_due_date_delay": 30,
      "supplier_due_date_rule": "days_or_end_of_month",
      "supplier_payment_method": "check",
      "updated_at": "2023-08-30T10:08:08.146343Z",
      "vat_number": "FR32123456789"
    }
  ],
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
}

Query Parameters

​
cursor
string

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

Example:

"dXBkYXRlZF9hdDoxNjc0MTIzNDU2"

​
limit
string

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

Example:

"20"

​
filter
string

You can choose to filter items on specific fields. Available fields and values:

  • id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • ledger_account_id: eq, not_eq
  • name: start_with
  • external_reference: eq, not_eq, in, not_in
Example:

"[{\"field\": \"ledger_account_id\", \"operator\": \"eq\", \"value\": \"123\"}]"

​
sort
string

You can choose to sort items on specific attributes Sort field may be prefixed with - for descending order. Example : id will sort by ascending order, -id will sort by descending order. Available fields : id

Example:

"-id"

Response

200
application/json

Returns a list of suppliers

The response is of type object.