Inquiry ======= The variety of reports we offer are applicable to different situations as briefly discussed later in this document. The main differences are national/international and online/offline. :national: Report for a company from the Netherlands. :international: Report for a company from outside the Netherlands. :online: Report without the intervention of an agent and requires a company ID. :offline: Report with the intervention of an agent and a company ID is optional. An inquiry has a status field to indicate whether the inquiry has finished or not so you know when it's possible to fetch the corresponding report. =========== ==================================================================== pending report is not ready yet canceled order is canceled negative no report available finished report is ready =========== ==================================================================== Place an inquiry ---------------- To place an inquiry, make a POST request to the https://inquiry.creditandcollection.nl/api/inquiries endpoint. HTTP Request ~~~~~~~~~~~~ ``POST https://inquiry.creditandcollection.nl/api/inquiries`` Request Body ~~~~~~~~~~~~ A description of the available attributes. .. _inquiry-attr-name: name ++++ :type: string :required: depends :max length: 100 See :ref:`inquiry-attr-companyid` to determine whether this attribute is required or not. address +++++++ :type: string :required: no :max length: 100 zipcode +++++++ :type: string :required: no :max length: 50 .. _inquiry-attr-city: city ++++ :type: string :required: depends :max length: 50 See :ref:`inquiry-attr-companyid` to determine whether this attribute is required or not. .. _inquiry-attr-country: country +++++++ :type: enum :required: depends :options: 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 See :ref:`inquiry-attr-companyid` to determine whether this attribute is required or not. .. _inquiry-attr-regnumber: reg_number ++++++++++ :type: string :required: depends :max length: 25 See :ref:`inquiry-attr-companyid` to determine whether this attribute is required or not. .. _inquiry-attr-vatnumber: vat_number ++++++++++ :type: string :required: no :max length: 25 See :ref:`inquiry-attr-companyid` to determine whether this attribute is required or not. tel_number ++++++++++ :type: string :required: no :max length: 25 product +++++++ :type: enum :required: yes :options: D44CI101, D44CI102, D44CI201, D44CI301, D44CI302, D44CI501, D44CI701, D44CI702, D44CI704, D44CI707, D44CI906, D44CI907 See :ref:`report-reporttypes` for more information about the available products. priority ++++++++ :type: enum :required: yes :options: normal, fast, immediate Only applicable for offline products. Defaults to **normal** otherwise. language ++++++++ :type: enum :required: depends :options: NL, EN Dutch is only available for inquiries on companies in the Netherlands and Belgium. Defaults to **EN** otherwise. reference +++++++++ :type: string :required: no :max length: 50 amount ++++++ :type: integer :required: no :min: 1 :max: 1000000 reason ++++++ :type: string :required: no :max length: 250 .. _inquiry-attr-companyid: company_id ++++++++++ :type: string :required: depends The id of a company obtained through the search API. Only required for online products. To help us identify the desired company, one of the following attribute combos is required in case the company ID is not known: - :ref:`inquiry-attr-country`, :ref:`inquiry-attr-vatnumber` - :ref:`inquiry-attr-country`, :ref:`inquiry-attr-regnumber` - :ref:`inquiry-attr-country`, :ref:`inquiry-attr-name`, :ref:`inquiry-attr-city` .. note:: There's one important exception for dutch companies. It's possible to place an inquiry without a :ref:`inquiry-attr-companyid` if :ref:`inquiry-attr-country` and :ref:`inquiry-attr-regnumber` is set. Priority national ~~~~~~~~~~~~~~~~~ =========== ==================================================================== normal Normal delay, max 1 working day. fast Express delay, max 4 working hours. immediate Flash delay, max 2 working hours. =========== ==================================================================== Priority international ~~~~~~~~~~~~~~~~~~~~~~ =========== ==================================================================== normal Normal delay, max 10 working days. fast Express delay, max 6 working days. immediate Flash delay, max 3 working days. =========== ==================================================================== Example ~~~~~~~ .. code-block:: sh curl \ --user username:password \ --request POST \ --header 'Content-Type: application/json' \ --data '{"company_id":"THISISAFAKEID","product":"D44CI701","language":"NL"}' \ 'https://inquiry.creditandcollection.nl/api/inquiries' Response ~~~~~~~~ See :ref:`inquiry-schema-inquiryitemresponse` schema for more information about the response format. .. code-block:: json { "item": { "id": 1, "name": "Groesman International B.V.", "address": null, "zipcode": null, "city": "Amsterdam", "country": "NL", "reg_number": null, "vat_number": null, "tel_number": null, "product": "D44CI701", "priority": "normal", "language": "NL", "amount": null, "reference": null, "reason": null, "status": "pending", "created_at": "2015-09-25T12:00:00Z", "finished_at": null, "refs": { "self": "\/api\/inquiries\/1", "report": "\/api\/inquiries\/1\/report" } } } Fetch an inquiry ---------------- To fetch an inquiry, make a GET request to the https://inquiry.creditandcollection.nl/api/inquiries/:inquiry_id endpoint. HTTP Request ~~~~~~~~~~~~ ``GET https://inquiry.creditandcollection.nl/api/inquiries/:inquiry_id`` Example ~~~~~~~ .. code-block:: sh curl \ --user username:password \ 'https://inquiry.creditandcollection.nl/api/inquiries/1' Response ~~~~~~~~ See :ref:`inquiry-schema-inquiryitemresponse` schema for more information about the response format. .. code-block:: json { "item": { "id": 1, "name": "Groesman International B.V.", "address": null, "zipcode": null, "city": "Amsterdam", "country": "NL", "reg_number": null, "vat_number": null, "tel_number": null, "product": "D44CI701", "priority": "normal", "language": "NL", "amount": null, "reference": null, "reason": null, "status": "finished", "created_at": "2015-09-25T12:00:00Z", "finished_at": "2015-09-25T12:00:15Z", "refs": { "self": "\/api\/inquiries\/1", "report": "\/api\/inquiries\/1\/report" } } } Browse inquiries ---------------- To browse inquiries, make a GET request to the https://inquiry.creditandcollection.nl/api/inquiries endpoint. HTTP Request ~~~~~~~~~~~~ ``GET https://inquiry.creditandcollection.nl/api/inquiries`` Query Parameters ~~~~~~~~~~~~~~~~ ============== ======= Parameter Default ============== ======= year month day status country page 1 ============== ======= The items are sorted by **created_at** in descending order. Example ~~~~~~~ .. code-block:: sh curl \ --user username:password \ 'https://inquiry.creditandcollection.nl/api/inquiries' Response ~~~~~~~~ See :ref:`inquiry-schema-inquirylistresponse` schema for more information about the response format. .. code-block:: json { "list": [ { "id": 1, "name": "Groesman International B.V.", "address": null, "zipcode": null, "city": "Amsterdam", "country": "NL", "reg_number": null, "vat_number": null, "tel_number": null, "product": "D44CI701", "priority": "normal", "language": "NL", "amount": null, "reference": null, "reason": null, "status": "finished", "created_at": "2015-09-25T12:00:00Z", "finished_at": "2015-09-25T12:00:15Z", "refs": { "self": "\/api\/inquiries\/1", "report": "\/api\/inquiries\/1\/report" } } ], "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. .. _inquiry-schema-inquiry: Inquiry ~~~~~~~ | ▸ **id** *(integer)* | Inquiry ID | ▸ **name** *(string|null)* | Company name | ▸ **address** *(string|null)* | Address | ▸ **zipcode** *(string|null)* | Zipcode | ▸ **city** *(string|null)* | City | ▸ **country** *(enum)* | Country code | See ISO 3166-1 alpha-2 | ▸ **reg_number** *(string|null)* | Registration number | ▸ **vat_number** *(string|null)* | VAT number | ▸ **tel_number** *(string|null)* | Phone number | ▸ **product** *(enum)* | Product code | Options: | - D44CI101 | - D44CI102 | - D44CI201 | - D44CI301 | - D44CI701 | - D44CI702 | - D44CI704 | ▸ **priority** *(enum)* | Priority | Options: | - normal | - fast | - immediate | ▸ **language** *(enum)* | Language code | Options: | - NL | - EN | ▸ **reference** *(string|null)* | Reference | ▸ **reason** *(string|null)* | Reason | ▸ **amount** *(integer|null)* | Amount | ▸ **status** *(enum)* | Status code | Options: | - pending | - canceled | - negative | - finished | ▸ **created_at** *(string)* | Entity created at | ▸ **finished_at** *(string)* | Inquiry finished at | ▸ **refs** *(object)* | ▸ **self** *(string)* | URI to itself | ▸ **report** *(string)* | URI to corresponding report | .. _inquiry-schema-inquiryitemresponse: InquiryItemResponse ~~~~~~~~~~~~~~~~~~~ | ▸ **item** (:ref:`Inquiry `) | .. _inquiry-schema-inquirylistresponse: InquiryListResponse ~~~~~~~~~~~~~~~~~~~ | ▸ **list** (:ref:`Inquiry[] `) | ▸ **meta** *(object)* | ▸ **items** *(integer)* | Number of items in list | ▸ **current_page** *(integer)* | Current page | ▸ **more_items** *(boolean)* | More items available |