Company
=======

Searching for companies
-----------------------

To search for companies, make a GET request to the
https://inquiry.creditandcollection.nl/api/companies endpoint.

HTTP Request
~~~~~~~~~~~~

``GET https://inquiry.creditandcollection.nl/api/companies``

Query Parameters
~~~~~~~~~~~~~~~~

================ ======= ====
Parameter        Default Note
================ ======= ====
term
reg_number
vat_number               not available in NL
name
city
country          NL      See :ref:`queryparams-countries`
zipcode
address_street
address_number
page             1       integer
inc_legal_entity 1       bool,
                         include legal entities,
                         only available in NL
inc_branches     1       bool,
                         include branches,
                         only available in NL
inc_terminated   1       bool,
                         include terminated companies,
                         only available in NL
================ ======= ====

.. _queryparams-countries:

Supported countries
+++++++++++++++++++

AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD,
BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC,
CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK,
DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE,
GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT,
HU, ID, IE, IL, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN,
KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME,
MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA,
NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM,
PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI,
SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK,
TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI,
VN, VU, WF, WS, YE, YT, YU, ZA, ZM, ZW

.. note::

  - The following query params are ignored if term is used as a search criteria:
    `reg_number`, `vat_number`, `name`, `city`, `address_street`, and
    `address_number`.
  - No items when search criteria is not sufficient.
  - Number of results per page can change in the future.

Example
~~~~~~~

.. code-block:: sh

  curl \
  --user username:password \
  --get \
  --data-urlencode 'country=NL' \
  --data-urlencode 'term=Groesman' \
  'https://inquiry.creditandcollection.nl/api/companies'

Response
~~~~~~~~

See :ref:`company-schema-companylistresponse` schema for more information about
the response format.

.. code-block:: json

  {
    "list": [
      {
        "id": "THISISAFAKEID",
        "name": "Groesman International B.V.",
        "reg_number": "97123456",
        "est_number": null,
        "vat_number": null,
        "address": "Postbus 86",
        "zipcode": "1000AA",
        "city": "Amsterdam",
        "country": "NL",
        "additional": "Hoofdvestiging",
        "comment": null
      }
    ],
    "meta": {
      "items": 1,
      "current_page": 1,
      "more_items": false
    }
  }

Schemas
-------

The following schemas represent the formats of the HTTP responses, returned by
the API, which are described on this page.

.. _company-schema-company:

Company
~~~~~~~

| ▸ **id** *(string)*
|  Company ID
| ▸ **name** *(string)*
|  Company name
| ▸ **reg_number** *(string)*
|  Registration number
| ▸ **est_number** *(string|null)*
|  Establishment/Branche number
| ▸ **vat_number** *(string|null)*
|  VAT number
| ▸ **address** *(string|null)*
|  Address
| ▸ **zipcode** *(string|null)*
|  Zipcode
| ▸ **city** *(string|null)*
|  City
| ▸ **country** *(enum)*
|  Country code
|  See ISO 3166-1 alpha-2
| ▸ **additional** *(string|null)*
|  Additional information
| ▸ **comment** *(string|null)*
|  Comment
| ▸ **active** *(bool)*
|  Indicates whether the company is active or not. Only available if company is
|  not active.
|

.. _company-schema-companylistresponse:

CompanyListResponse
~~~~~~~~~~~~~~~~~~~

| ▸ **list** (:ref:`Company[] <company-schema-company>`)
| ▸ **meta** *(object)*
|   ▸ **items** *(integer)*
|    Number of items in list
|   ▸ **current_page** *(integer)*
|    Current page
|   ▸ **more_items** *(boolean)*
|    More items available
|