Sign in
Clients

List Clients

Lists the clients.

get/c/{company_id}/entities/clients

Request

  • Base URL: https://api-v2.fattureincloud.it
  • URL: https://api-v2.fattureincloud.it/c/{company_id}/entities/clients
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api-v2.fattureincloud.it/oauth/authorize, token URL https://api-v2.fattureincloud.it/oauth/token, scopes: entity.clients:r)
    • HTTP bearer

Query parameters

fieldsstring

List of comma-separated fields.

fieldset'basic' | 'detailed'

Name of the fieldset.

sortstring

List of comma-separated fields for result sorting (minus for desc sorting).

pageinteger

The page to retrieve.

per_pageinteger

The size of the page.

qstring

Query for filtering the results.

Response

Example response

current_pageinteger nullable

Current page number.

first_page_urlstring uri nullable

First page url.

frominteger nullable

First result of the page.

last_pageinteger nullable

Last page number.

last_page_urlstring uri nullable

Last page url.

next_page_urlstring uri nullable

Next page url

pathstring uri nullable

Request path.

per_pageinteger nullable

Number of result per page.

prev_page_urlstring uri nullable

Previous page url.

tointeger nullable

Last result of the page.

totalinteger nullable

Total number of results

Example response

{
  "data": [
    {
      "code": "123",
      "name": "Rossi S.r.l.",
      "vat_number": "IT01234567890",
      "tax_code": "RSSMRA44A12E890Q",
      "address_street": "Via dei tigli, 12",
      "address_postal_code": "24010",
      "address_city": "Bergamo",
      "address_province": "BG",
      "country": "Italia",
      "country_iso": "Italia",
      "email": "mario.rossi@example.it",
      "certified_email": "mario.rossi@pec.example.it",
      "default_vat": {
        "value": 22,
        "description": "Non imponibile art. 123",
        "notes": "IVA non imponibile ai sensi dell'articolo 123, comma 2"
      },
      "default_payment_terms": 30,
      "default_payment_method": {
        "default_payment_account": {
          "name": "Conto Banca Intesa"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.