2.0info: 1.10.0 Dados description: Serviço responsável pela consulta do Marketing Intelligence x-senior-domain: Marketing Intelligence x-senior-domain-path: mktint x-senior-service-path: data contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /mktint/datasecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listCompaniesCnae: post: description: Listar CNAE's secundários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompaniesCnaeRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Listar CNAE's secundários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompaniesCnaeRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanySubsegment: post: description: SubSegmento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: segmentIds: type: array items: type: string description: Id do Segmento search: type: string description: Sub segmento page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanySubsegmentRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: SubSegmento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: segmentIds: type: array items: type: string description: Id do Segmento search: type: string description: Sub segmento page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanySubsegmentRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /searchCompanies: post: description: Buscar Empresas com filtros x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – filter properties: filter: #/definitions/searchCompaniesFilterRecord page: type: integer description: Página size: type: integer description: Quantidade de registros previewMode: #/definitions/previewModeEnum useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/searchCompaniesRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Buscar Empresas com filtros x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – filter properties: filter: #/definitions/searchCompaniesFilterRecord page: type: integer description: Página size: type: integer description: Quantidade de registros previewMode: #/definitions/previewModeEnum useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/searchCompaniesRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /getSmartApproach: post: description: Gerar abordagem inteligente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj – productName properties: cnpj: type: string description: CNPJ productName: type: string description: Nome do Produto useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError get: description: Gerar abordagem inteligente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj – productName properties: cnpj: type: string description: CNPJ productName: type: string description: Nome do Produto useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError /listCompanyCnaeMainActivity: post: description: Atividade Principal x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: subsegmentIds: type: array items: type: string description: Id do SubSegmento search: type: string description: Atividade principal code: type: string description: Código da atividade page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyCnaeMainActivityRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Atividade Principal x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: subsegmentIds: type: array items: type: string description: Id do SubSegmento search: type: string description: Atividade principal code: type: string description: Código da atividade page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyCnaeMainActivityRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanySegment: post: description: Segmento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: search: type: string description: Segmento page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanySegmentRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Segmento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: search: type: string description: Segmento page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanySegmentRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanyLegalNature: post: description: Natureza Jurídica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: search: type: string description: Natureza Jurídica page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyLegalNatureRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Natureza Jurídica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: search: type: string description: Natureza Jurídica page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyLegalNatureRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanyRelation: post: description: Listar Empresas Relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj – revenueBusinessId properties: cnpj: type: string description: CNPJ da Empresa revenueBusinessId: type: string description: Id da Receita Federal page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/companyRelationRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Listar Empresas Relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj – revenueBusinessId properties: cnpj: type: string description: CNPJ da Empresa revenueBusinessId: type: string description: Id da Receita Federal page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/companyRelationRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /getCompany: post: description: Pegar Empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – id – revenueBusinessId – cnpj – name – fantasyName – openingDate – shareCapitalValue – legalNature – classLegalNature – segment – subSegment – employeeNumber – estimatedRevenue – isSimpleNational – dateOptedSimpleNational – dateExcludedSimpleNational – isMei – dateOptedMei – dateExcludedMei – address – addressNumber – addressDistrict – addressComplement – addressZipCode – addressState – addressCity – addressLongitude – addressLatitude – phoneNumberOne – phoneNumberDdd – email – cnaeMainActivityId – cnaeMainActivityDescription – updateDateFederalRevenue – updateDateRais – totalDebtsValue – totalSocialSecurityDebtsValue – lastSocialSecurityDebtDate – numberOfDebtsWithFgts – lastDebtWithFgtsDate – totalNonSocialSecurityDebtsValue – lastNonSocialSecurityDebtDate properties: id: type: string description: CNPJ revenueBusinessId: type: string description: Id de negócio da receita cnpj: type: string description: CNPJ name: type: string description: Nome fantasyName: type: string description: Nome openingDate: type: string description: Data de Abertura shareCapitalValue: type: string description: Capital Social legalNature: type: string description: Natureza Jurídica classLegalNature: type: string description: Classe da Natureza Jurídica segment: type: string description: Segmento subSegment: type: string description: Sub Segmento employeeNumber: type: string description: Numero de Funcionários estimatedRevenue: type: string description: Receita Estimada isSimpleNational: type: boolean description: É Simples Nacional dateOptedSimpleNational: type: string description: Data que a Empresa optou por ser Simples Nacional dateExcludedSimpleNational: type: string description: Data que a Empresa deixou de ser Simples Nacional isMei: type: boolean description: É Mei dateOptedMei: type: string description: Data que a Empresa optou por ser Mei dateExcludedMei: type: string description: Data que a Empresa deixou de ser Mei companySize: #/definitions/companySizeEnum address: type: string description: Endereço addressNumber: type: string description: Número do Endereço addressDistrict: type: string description: Bairro do Endereço addressComplement: type: string description: Complemento da Endereço addressZipCode: type: string description: CEP do Endereço addressState: type: string description: Estado do Endereço addressCity: type: string description: Cidade do Endereço addressLongitude: type: number description: Longitude do Endereço addressLatitude: type: number description: Latitude do Endereço phoneNumberOne: type: string description: Telefone(1) phoneNumberDdd: type: string description: DDD do Telefone email: type: string description: Email cnaeMainActivityId: type: string description: Id do Cnae da Atividade Principal cnaeMainActivityDescription: type: string description: Descrição do Cnae da Atividade Principal updateDateFederalRevenue: type: string description: Data de Atualização na Receita Federal updateDateRais: type: string description: Data de Atualização no RAIS totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias lastSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Previdenciária numberOfDebtsWithFgts: type: integer description: Número de Dívidas com FGTS lastDebtWithFgtsDate: type: string description: Data de Inscrição da Última Dívida com FGTS totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias lastNonSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Não Previdenciária default: description: Error response schema: #/definitions/genericError get: description: Pegar Empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – id – revenueBusinessId – cnpj – name – fantasyName – openingDate – shareCapitalValue – legalNature – classLegalNature – segment – subSegment – employeeNumber – estimatedRevenue – isSimpleNational – dateOptedSimpleNational – dateExcludedSimpleNational – isMei – dateOptedMei – dateExcludedMei – address – addressNumber – addressDistrict – addressComplement – addressZipCode – addressState – addressCity – addressLongitude – addressLatitude – phoneNumberOne – phoneNumberDdd – email – cnaeMainActivityId – cnaeMainActivityDescription – updateDateFederalRevenue – updateDateRais – totalDebtsValue – totalSocialSecurityDebtsValue – lastSocialSecurityDebtDate – numberOfDebtsWithFgts – lastDebtWithFgtsDate – totalNonSocialSecurityDebtsValue – lastNonSocialSecurityDebtDate properties: id: type: string description: CNPJ revenueBusinessId: type: string description: Id de negócio da receita cnpj: type: string description: CNPJ name: type: string description: Nome fantasyName: type: string description: Nome openingDate: type: string description: Data de Abertura shareCapitalValue: type: string description: Capital Social legalNature: type: string description: Natureza Jurídica classLegalNature: type: string description: Classe da Natureza Jurídica segment: type: string description: Segmento subSegment: type: string description: Sub Segmento employeeNumber: type: string description: Numero de Funcionários estimatedRevenue: type: string description: Receita Estimada isSimpleNational: type: boolean description: É Simples Nacional dateOptedSimpleNational: type: string description: Data que a Empresa optou por ser Simples Nacional dateExcludedSimpleNational: type: string description: Data que a Empresa deixou de ser Simples Nacional isMei: type: boolean description: É Mei dateOptedMei: type: string description: Data que a Empresa optou por ser Mei dateExcludedMei: type: string description: Data que a Empresa deixou de ser Mei companySize: #/definitions/companySizeEnum address: type: string description: Endereço addressNumber: type: string description: Número do Endereço addressDistrict: type: string description: Bairro do Endereço addressComplement: type: string description: Complemento da Endereço addressZipCode: type: string description: CEP do Endereço addressState: type: string description: Estado do Endereço addressCity: type: string description: Cidade do Endereço addressLongitude: type: number description: Longitude do Endereço addressLatitude: type: number description: Latitude do Endereço phoneNumberOne: type: string description: Telefone(1) phoneNumberDdd: type: string description: DDD do Telefone email: type: string description: Email cnaeMainActivityId: type: string description: Id do Cnae da Atividade Principal cnaeMainActivityDescription: type: string description: Descrição do Cnae da Atividade Principal updateDateFederalRevenue: type: string description: Data de Atualização na Receita Federal updateDateRais: type: string description: Data de Atualização no RAIS totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias lastSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Previdenciária numberOfDebtsWithFgts: type: integer description: Número de Dívidas com FGTS lastDebtWithFgtsDate: type: string description: Data de Inscrição da Última Dívida com FGTS totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias lastNonSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Não Previdenciária default: description: Error response schema: #/definitions/genericError /listCompanyPartners: post: description: Listar Sócios da Empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/partnerRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Listar Sócios da Empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/partnerRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /getCompanySummary: post: description: Gerar resumo da empresa com IA x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError get: description: Gerar resumo da empresa com IA x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError /listCompanyCnae: post: description: Listar CNAE's secundários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/cnaeRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Listar CNAE's secundários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/cnaeRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanyClassLegalNature: post: description: Classe da Natureza Jurídica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: legalNatureId: type: integer description: Id da Natureza Jurídica search: type: string description: Classe da Natureza Jurídica page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyClassLegalNatureRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError get: description: Classe da Natureza Jurídica x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: legalNatureId: type: integer description: Id da Natureza Jurídica search: type: string description: Classe da Natureza Jurídica page: type: integer description: Página size: type: integer description: Quantidade de registros useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: #/definitions/listCompanyClassLegalNatureRecord totalElements: type: integer description: Total de Registros totalPages: type: integer description: Total de Páginas default: description: Error response schema: #/definitions/genericError /listCompanies: post: description: Litar Empresas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string description: CNPJ's useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – companies properties: companies: #/definitions/getCompanyRecord default: description: Error response schema: #/definitions/genericError get: description: Litar Empresas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string description: CNPJ's useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset responses: 200: description: Ok schema: type: object required: – companies properties: companies: #/definitions/getCompanyRecord default: description: Error response schema: #/definitions/genericErrordefinitions: companySizeEnum: type: string enum: – NOT_INFORMED – MICRO_ENTERPRISE – SMALL_BUSINESS – MEDIUM_AND_LARGE previewModeEnum: type: string enum: – LIST – MAP companyTypeEnum: type: string enum: – HEAD_OFFICE – BRANCH companyShareCapitalRelationalOperatorEnum: type: string enum: – EQUAL – GREATER_THAN – GREATER_THAN_OR_EQUAL – LESS_THAN companyNumberEmployeesEnum: type: string enum: – UP_TO_ONE – FROM_ONE_TO_TREE – FROM_FOUR_TO_SEVEN – FROM_EIGHT_TO_TEN – FROM_ELEVEN_TO_FIFTEEN – FROM_SIXTEEN_TO_TWENTY – FROM_TWENTY_ONE_TO_THIRTY – FROM_THIRTY_ONE_TO_FORTY – FROM_FORTY_ONE_TO_FIFTY – FROM_FIFTY_ONE_TO_SEVENTY – FROM_SEVENTY_ONE_TO_HUNDRED – FROM_HUNDRED_ONE_TO_TWO_HUNDRED – FROM_TWO_HUNDRED_ONE_TO_THREE_HUNDRED – FROM_THREE_HUNDRED_ONE_TO_FOUR_HUNDRED – FROM_FOUR_HUNDRED_ONE_TO_FIVE_HUNDRED – FROM_FIVE_HUNDRED_ONE_TO_SIX_HUNDRED – FROM_SIX_HUNDRED_ONE_TO_SEVEN_HUNDRED – FROM_SEVEN_HUNDRED_ONE_TO_EIGHT_HUNDRED – FROM_EIGHT_HUNDRED_ONE_TO_NINE_HUNDRED – FROM_NINE_HUNDRED_ONE_TO_THOUSAND – OVER_THOUSAND_ONE companyEstimatedRevenueEnum: type: string enum: – LESS_THAN_OR_EQUAL_TO_EIGHTY_ONE_THOUSAND – LESS_THAN_OR_EQUAL_TO_THREE_HUNDRED_AND_SIXTY_THOUSAND – FROM_THREE_HUNDRED_AND_SIXTY_THOUSAND_TO_ONE_MILLION – FROM_THREE_HUNDRED_AND_SIXTY_THOUSAND_TO_FOUR_MILLION_AND_EIGHT_HUNDRED_THOUSAND – FROM_ONE_MILLION_TO_ONE_HUNDRED_MILLION – FROM_ONE_HUNDRED_MILLION_TO_THREE_HUNDRED_MILLION – FROM_THREE_HUNDRED_AND_SIX_HUNDRED_MILLION – FROM_SIX_HUNDRED_MILLION_TO_ONE_BILLION – FROM_ONE_BILLION_THIRTY_BILLION – FROM_THIRTY_BILLION_TO_ONE_HUNDRED_BILLION – BIGGER_THAN_A_HUNDRED_BILLION externalSystemEnum: type: string enum: – CRM listCompanyLegalNatureRecord: type: object required: – id – name properties: id: type: integer description: Código name: type: string description: Nome listCompanyClassLegalNatureRecord: type: object required: – id – name properties: id: type: integer description: Código name: type: string description: Nome listCompanySegmentRecord: type: object required: – id – name properties: id: type: string description: Código name: type: string description: Nome listCompanySubsegmentRecord: type: object required: – id – name properties: id: type: string description: Código name: type: string description: Nome searchCompaniesFilterRecord: type: object properties: companyName: type: string description: Nome da Empresa companyCnpj: type: string description: CNPJ da Empresa companySegment: type: array items: type: string description: Segmentos da Empresa companySubsegment: type: array items: type: string description: Sub-segmentos da Empresa companyCnaeMainActivity: type: array items: type: string description: CNAE's Principal localizationCep: type: string description: CEP localizationState: type: array items: type: string description: Sigla Estado localizationCity: type: array items: type: string description: Cidade localizationDistrict: type: string description: Bairro localizationAddress: type: string description: Endereço localizationAddressNumber: type: integer description: Número do Endereço localizationCepStart: type: string description: Faixa inicial do CEP localizationCepEnd: type: string description: Faixa final do CEP companyType: #/definitions/companyTypeEnum companySize: #/definitions/companySizeEnum companyLegalNature: type: integer description: Natureza Jurídica companyClassLegalNature: type: integer description: Classe da Natureza Jurídica companyShareCapitalOperator: #/definitions/companyShareCapitalRelationalOperatorEnum companyShareCapitalValue: type: string description: Capital Social companyNumberEmployees: type: array items: #/definitions/companyNumberEmployeesEnum description: Numero de Funcionários companyEstimatedRevenue: type: array items: #/definitions/companyEstimatedRevenueEnum description: Faturamento Estimado da Empresa snOption: type: boolean description: Optante do Simples Nacional meiOption: type: boolean description: É optante do MEI companyDateOpeningStart: type: string description: Faixa inicial da Data de abertura format: date companyDateOpeningEnd: type: string description: Faixa final da Data de abertura format: date hasDebts: type: boolean description: Possui Dívidas com a União hasSocialSecurityDebts: type: boolean description: Possui Dívidas Previdenciárias hasDebtsWithFgts: type: boolean description: Possui Dívidas com FGTS hasNonSocialSecurityDebts: type: boolean description: Possui Dívidas Não Previdenciárias listCompanyCnaeMainActivityRecord: type: object required: – id – name properties: id: type: string description: Código name: type: string description: Nome searchCompaniesRecord: type: object required: – id – companyCnpj – companyName – companyType – localizationState – localizationCity – localizationLatitude – localizationLongitude – companyCnaeMainActivity – companyShareCapitalValue – totalDebtsValue – totalSocialSecurityDebtsValue – numberOfDebtsWithFgts – totalNonSocialSecurityDebtsValue – exportTo properties: id: type: string description: CNPJ da Empresa companyCnpj: type: string description: CNPJ da Empresa companyName: type: string description: Nome da Empresa companyType: #/definitions/companyTypeEnum localizationState: type: string description: Sigla do Estado localizationCity: type: string description: Cidade localizationLatitude: type: number description: Latitude format: double localizationLongitude: type: number description: Longitude format: double companyCnaeMainActivity: type: string description: Id da Subclasse do CNAE companyShareCapitalValue: type: string description: Capital Social totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias numberOfDebtsWithFgts: type: integer description: Número de Dívidas com FGTS totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias exportTo: type: array items: #/definitions/externalSystemEnum description: Exportado para partnerRecord: type: object required: – name – qualification properties: name: type: string description: Nome qualification: type: string description: Qualificação listCompaniesCnaeRecord: type: object required: – cnpj – cnaes properties: cnpj: type: string description: CNPJ cnaes: type: array items: #/definitions/cnaeRecord description: Cnaes cnaeRecord: type: object required: – main – id – name properties: main: type: boolean description: É primário id: type: integer description: Id name: type: string description: Nome companyRelationRecord: type: object required: – cnpj – name – fantasyName – companyType – city – acronymState properties: cnpj: type: string description: CNPJ name: type: string description: Nome fantasyName: type: string description: Nome fantasia companyType: #/definitions/companyTypeEnum city: type: string description: Cidade acronymState: type: string description: Sigla do Estado getCompanyRecord: type: object required: – id – revenueBusinessId – cnpj – name – fantasyName – openingDate – shareCapitalValue – legalNature – classLegalNature – segment – subSegment – employeeNumber – estimatedRevenue – isSimpleNational – dateOptedSimpleNational – dateExcludedSimpleNational – isMei – dateOptedMei – dateExcludedMei – address – addressNumber – addressDistrict – addressComplement – addressZipCode – addressState – addressCity – addressLongitude – addressLatitude – phoneNumberOne – phoneNumberDdd – email – cnaeMainActivityId – cnaeMainActivityDescription – updateDateFederalRevenue – updateDateRais – totalDebtsValue – totalSocialSecurityDebtsValue – lastSocialSecurityDebtDate – numberOfDebtsWithFgts – lastDebtWithFgtsDate – totalNonSocialSecurityDebtsValue – lastNonSocialSecurityDebtDate properties: id: type: string description: CNPJ revenueBusinessId: type: string description: Id de negócio da receita cnpj: type: string description: CNPJ name: type: string description: Nome fantasyName: type: string description: Nome openingDate: type: string description: Data de Abertura format: date shareCapitalValue: type: string description: Capital Social legalNature: type: string description: Natureza Jurídica classLegalNature: type: string description: Classe da Natureza Jurídica segment: type: string description: Segmento subSegment: type: string description: Sub Segmento employeeNumber: type: string description: Numero de Funcionários estimatedRevenue: type: string description: Receita Estimada isSimpleNational: type: boolean description: É Simples Nacional dateOptedSimpleNational: type: string description: Data que a Empresa optou por ser Simples Nacional format: date dateExcludedSimpleNational: type: string description: Data que a Empresa deixou de ser Simples Nacional format: date isMei: type: boolean description: É Mei dateOptedMei: type: string description: Data que a Empresa optou por ser Mei format: date dateExcludedMei: type: string description: Data que a Empresa deixou de ser Mei format: date companySize: #/definitions/companySizeEnum address: type: string description: Endereço addressNumber: type: string description: Número do Endereço addressDistrict: type: string description: Bairro do Endereço addressComplement: type: string description: Complemento da Endereço addressZipCode: type: string description: CEP do Endereço addressState: type: string description: Estado do Endereço addressCity: type: string description: Cidade do Endereço addressLongitude: type: number description: Longitude do Endereço format: double addressLatitude: type: number description: Latitude do Endereço format: double phoneNumberOne: type: string description: Telefone(1) phoneNumberDdd: type: string description: DDD do Telefone email: type: string description: Email cnaeMainActivityId: type: string description: Id do Cnae da Atividade Principal cnaeMainActivityDescription: type: string description: Descrição do Cnae da Atividade Principal updateDateFederalRevenue: type: string description: Data de Atualização na Receita Federal format: date-time updateDateRais: type: string description: Data de Atualização no RAIS format: date-time totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias lastSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Previdenciária format: date numberOfDebtsWithFgts: type: integer description: Número de Dívidas com FGTS lastDebtWithFgtsDate: type: string description: Data de Inscrição da Última Dívida com FGTS format: date totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias lastNonSocialSecurityDebtDate: type: string description: Data de Inscrição da Última Dívida Não Previdenciária format: date genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE