A finalidade deste método é possibilitar a consulta de companhias.
GET api/v1/sm/company?DATE_FOUNDATION={DATE_FOUNDATION}&LAST_UPDATE_DATE={LAST_UPDATE_DATE}&NUMBER_COMPANY={NUMBER_COMPANY}&NUMBER_SEGMENT={NUMBER_SEGMENT}®ISTER_NUMBER={REGISTER_NUMBER}&NUMBER_DIVISION={NUMBER_DIVISION}&USES_SFA={USES_SFA}&_pageNo={_pageNo}&_pageSize={_pageSize}
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á. |
Não há.
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á. |
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á. |
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} ]
Exemplo (Sample):
<ArrayOfCompanyResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common"> <CompanyResponseDTO> <ADDRESS>sample string 1</ADDRESS> <ADDRESS_COMPLEMENT>sample string 2</ADDRESS_COMPLEMENT> <ADDRESS_NUMBER>sample string 3</ADDRESS_NUMBER> <CITY>sample string 4</CITY> <COUNTRY>sample string 5</COUNTRY> <DATE_FOUNDATION>2020-05-07T13:56:45.1010564-03:00</DATE_FOUNDATION> <DISTRICT>sample string 6</DISTRICT> <EMAIL>sample string 7</EMAIL> <FAX_AREA_CODE>sample string 8</FAX_AREA_CODE> <FAX_NUMBER>sample string 9</FAX_NUMBER> <HOME_PAGE>sample string 10</HOME_PAGE> <LAST_UPDATE_DATE>2020-05-07T13:56:45.1010564-03:00</LAST_UPDATE_DATE> <MICRO_COMPANY>sample string 15</MICRO_COMPANY> <NAME>sample string 11</NAME> <NUMBER_COMPANY>13</NUMBER_COMPANY> <NUMBER_DIVISION>14</NUMBER_DIVISION> <NUMBER_MAIN_SEGMENT>1</NUMBER_MAIN_SEGMENT> <PHONE_AREA_CODE_1>sample string 16</PHONE_AREA_CODE_1> <PHONE_AREA_CODE_2>sample string 19</PHONE_AREA_CODE_2> <PHONE_COMPLEMENT_1>sample string 17</PHONE_COMPLEMENT_1> <PHONE_COMPLEMENT_2>sample string 20</PHONE_COMPLEMENT_2> <PHONE_NUMBER_1>sample string 18</PHONE_NUMBER_1> <PHONE_NUMBER_2>sample string 21</PHONE_NUMBER_2> <REDUCED_NAME>sample string 12</REDUCED_NAME> <REGISTER_NUMBER>sample string 22</REGISTER_NUMBER> <REG_NUMBER>1</REG_NUMBER> <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT> <RESPONSIBLE>sample string 29</RESPONSIBLE> <SEQ_PERSON>23</SEQ_PERSON> <STATE>sample string 24</STATE> <STATE_REGISTRATION>sample string 25</STATE_REGISTRATION> <STATUS>sample string 26</STATUS> <TAXATION_REGIME_NUMBER>1</TAXATION_REGIME_NUMBER> <TRADING_NAME>sample string 27</TRADING_NAME> <UPDATE_DATE_COMPANY>2020-05-07T13:56:45.1010564-03:00</UPDATE_DATE_COMPANY> <UPDATE_DATE_PERSON>2020-05-07T13:56:45.1010564-03:00</UPDATE_DATE_PERSON> <ZIP_CODE>sample string 28</ZIP_CODE> </CompanyResponseDTO> <CompanyResponseDTO> <ADDRESS>sample string 1</ADDRESS> <ADDRESS_COMPLEMENT>sample string 2</ADDRESS_COMPLEMENT> <ADDRESS_NUMBER>sample string 3</ADDRESS_NUMBER> <CITY>sample string 4</CITY> <COUNTRY>sample string 5</COUNTRY> <DATE_FOUNDATION>2020-05-07T13:56:45.1010564-03:00</DATE_FOUNDATION> <DISTRICT>sample string 6</DISTRICT> <EMAIL>sample string 7</EMAIL> <FAX_AREA_CODE>sample string 8</FAX_AREA_CODE> <FAX_NUMBER>sample string 9</FAX_NUMBER> <HOME_PAGE>sample string 10</HOME_PAGE> <LAST_UPDATE_DATE>2020-05-07T13:56:45.1010564-03:00</LAST_UPDATE_DATE> <MICRO_COMPANY>sample string 15</MICRO_COMPANY> <NAME>sample string 11</NAME> <NUMBER_COMPANY>13</NUMBER_COMPANY> <NUMBER_DIVISION>14</NUMBER_DIVISION> <NUMBER_MAIN_SEGMENT>1</NUMBER_MAIN_SEGMENT> <PHONE_AREA_CODE_1>sample string 16</PHONE_AREA_CODE_1> <PHONE_AREA_CODE_2>sample string 19</PHONE_AREA_CODE_2> <PHONE_COMPLEMENT_1>sample string 17</PHONE_COMPLEMENT_1> <PHONE_COMPLEMENT_2>sample string 20</PHONE_COMPLEMENT_2> <PHONE_NUMBER_1>sample string 18</PHONE_NUMBER_1> <PHONE_NUMBER_2>sample string 21</PHONE_NUMBER_2> <REDUCED_NAME>sample string 12</REDUCED_NAME> <REGISTER_NUMBER>sample string 22</REGISTER_NUMBER> <REG_NUMBER>1</REG_NUMBER> <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT> <RESPONSIBLE>sample string 29</RESPONSIBLE> <SEQ_PERSON>23</SEQ_PERSON> <STATE>sample string 24</STATE> <STATE_REGISTRATION>sample string 25</STATE_REGISTRATION> <STATUS>sample string 26</STATUS> <TAXATION_REGIME_NUMBER>1</TAXATION_REGIME_NUMBER> <TRADING_NAME>sample string 27</TRADING_NAME> <UPDATE_DATE_COMPANY>2020-05-07T13:56:45.1010564-03:00</UPDATE_DATE_COMPANY> <UPDATE_DATE_PERSON>2020-05-07T13:56:45.1010564-03:00</UPDATE_DATE_PERSON> <ZIP_CODE>sample string 28</ZIP_CODE> </CompanyResponseDTO> </ArrayOfCompanyResponseDTO>