Consulta de Companhias – GET

Objetivo

A finalidade deste método é possibilitar a consulta de companhias.

Chamada

GET api/v1/sm/company?DATE_FOUNDATION={DATE_FOUNDATION}&LAST_UPDATE_DATE={LAST_UPDATE_DATE}&NUMBER_COMPANY={NUMBER_COMPANY}&NUMBER_SEGMENT={NUMBER_SEGMENT}&REGISTER_NUMBER={REGISTER_NUMBER}&NUMBER_DIVISION={NUMBER_DIVISION}&USES_SFA={USES_SFA}&_pageNo={_pageNo}&_pageSize={_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
date_foundation	Foundation Date – (dd/mm/aaaa ou ddmmaaaa) – (Optional)	string	Não há.
last_update_date	Last Update Date – Formats: ddmmaaaahhmm or dd/mm/yyyy hh:mm – Optional	string	Não há.
number_company	Number Company – (000) – (Optional)	integer	Não há.
number_segment	Number Segment – (00) – (Optional)	integer	Não há.
register_number	Legal Entity – Brazilian Registry of Corporate Taxpayers – (00.000.000/0001-00 or 00000000000000) – (Optional)	string	Não há.
number_division	Number Division – (00) – (Optional)	integer	Não há.
uses_SFA	Uses Sales Force Automation (‘S’ – Yes, ‘N’ – No) 0 (Optional)	string	Não há.
_pageNo		integer	Não há.
_pageSize		integer	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
NotFound (404)
BadRequest (400)
Unauthorized (401)
InternalServerError (500)

Descrição do Recurso (Resource Description)

CompanyResponseDTO – List of Company

Collection of CompanyResponseDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
address	Company Address	string	Não há.
address_complement	Address Complement	string	Não há.
address_number	Address Number	string	Não há.
city	Company City	string	Não há.
country	Country	string	Não há.
date_foundation	Foundation Date	date	Não há.
district	District	string	Não há.
email	E-mail	string	Não há.
fax_area_code	Fax Area Code	string	Não há.
fax_number	Fax Number	string	Não há.
home_page	Home Page	string	Não há.
last_update_date	Last Update Date	date	Não há.
name	Company Name	string	Não há.
reduced_name	Company Name	string	Não há.
number_company	Number Company	integer	Não há.
number_division	Division Number	integer	Não há.
number_main_segment	Company Main Segment Number	integer	Não há.
micro_company	Indicates Micro Company (N – No or S – Yes)	string	Não há.
phone_area_code_1	Phone Area Code 1	string	Não há.
phone_complement_1	Phone Complement 1	string	Não há.
phone_number_1	Phone Number 1	string	Não há.
phone_area_code_2	Phone Area Code 2	string	Não há.
phone_complement_2	Phone Complement 2	string	Não há.
phone_number_2	Phone Number 2	string	Não há.
register_number	Brazilian Registry of Corporate Taxpayers (Legal Entity)	string	Não há.
seq_person	Sequence Attributed to a Company	integer	Não há.
state	Company State	string	Não há.
state_registration	State Registration	string	Não há.
status	Status (A = Active – I = Inactive )	string	Não há.
trading_name	Company Fantasy Name	string	Não há.
zip_code	Company CEP	string	Não há.
responsible	Responsible	string	Não há.
taxation_regime_number	Taxation regime number	integer	Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "address": "sample string 1",
    "address_complement": "sample string 2",
    "address_number": "sample string 3",
    "city": "sample string 4",
    "country": "sample string 5",
    "date_foundation": "2019-11-07T16:37:57.3985016-03:00",
    "district": "sample string 6",
    "email": "sample string 7",
    "fax_area_code": "sample string 8",
    "fax_number": "sample string 9",
    "home_page": "sample string 10",
    "last_update_date": "2019-11-07T16:37:57.3985016-03:00",
    "name": "sample string 11",
    "reduced_name": "sample string 12",
    "number_company": 13,
    "number_division": 14,
    "number_main_segment": 1,
    "micro_company": "sample string 15",
    "phone_area_code_1": "sample string 16",
    "phone_complement_1": "sample string 17",
    "phone_number_1": "sample string 18",
    "phone_area_code_2": "sample string 19",
    "phone_complement_2": "sample string 20",
    "phone_number_2": "sample string 21",
    "register_number": "sample string 22",
    "seq_person": 23,
    "state": "sample string 24",
    "state_registration": "sample string 25",
    "status": "sample string 26",
    "trading_name": "sample string 27",
    "zip_code": "sample string 28",
    "responsible": "sample string 29",
    "taxation_regime_number": 1

}, { "address": "sample string 1", "address_complement": "sample string 2", "address_number": "sample string 3", "city": "sample string 4", "country": "sample string 5", "date_foundation": "2019-11-07T16:37:57.3985016-03:00", "district": "sample string 6", "email": "sample string 7", "fax_area_code": "sample string 8", "fax_number": "sample string 9", "home_page": "sample string 10", "last_update_date": "2019-11-07T16:37:57.3985016-03:00", "name": "sample string 11", "reduced_name": "sample string 12", "number_company": 13, "number_division": 14, "number_main_segment": 1, "micro_company": "sample string 15", "phone_area_code_1": "sample string 16", "phone_complement_1": "sample string 17", "phone_number_1": "sample string 18", "phone_area_code_2": "sample string 19", "phone_complement_2": "sample string 20", "phone_number_2": "sample string 21", "register_number": "sample string 22", "seq_person": 23, "state": "sample string 24", "state_registration": "sample string 25", "status": "sample string 26", "trading_name": "sample string 27", "zip_code": "sample string 28", "responsible": "sample string 29", "taxation_regime_number": 1} ]

application/xml, text/xml