# Documentação das APIs de integração do Totvs CRM

A documentação das APIs de integração do Totvs CRM segue a especificação [OpenAPI 3.0.2](http://spec.openapis.org/oas/v3.0.2) e está estruturada em diretórios no Gitlab:

integration > service > endpoint > arquivo.yaml

No nome do arquivo de extensão .yaml da entidade é informado a versão do contrato que servirá como base para as requisições.

Exemplo:

customerV1-openapi.yaml

APIs de integração disponíveis, separadas por microsserviço do CRM:

**Administration** - Dados administrativos do CRM

| Serviço | API de integração | Descritivo |
| ----------------- | --------------------------------- | -------------------------------------- |
| administration | companies | Empresas/filiais com email, docs e telefone |
| administration | company-emails | Emails da filial |
| administration | company-identification-documents | Documentos de identificação da filial |
| administration | company-phones | Telefones da filial |
| administration | currencies | Moedas |
| administration | exchange-rates | Taxas de conversão de moeda |
| administration | identification-documents | Documentos de identificação (CPF, CI, ...) |
| administration | measurement-units | Unidades de medida |

**Analytics** - Dados analíticos

| Serviço | API de integração | Descritivo |
| -------- | ----------------- | ------------------------------------------------------------------------- |
| analytics | datasets | Conjunto de dados para análise e tomada de decisão na ferramenta Analytics |

**Common-data** - Dados comuns

| Serviço | API de integração | Descritivo |
| ------------- | ----------------- | -------------------------------- |
| common-data | cities | Cidades |
| common-data | countries | Países |
| common-data | email-types | Tipos de email |
| common-data | phone-types | Tipos de telefone |
| common-data | states | Unidades federativas |

**Customer** - Cliente, lead e contato

| Serviço | API de integração | Descritivo |
| -------- | --------------------------------- | ---------------------------------- |
| customer | addresses | Endereços do cliente/lead/contato |
| customer | asset-types | Tipo de ativos |
| customer | assets | Ativos de clientes/leads |
| customer | blocked-financial | Bloqueios financeiros |
| customer | contacts | Contatos |
| customer | customer-classifications* | Classificação de clientes |
| customer | customer-companies-unlink* | Remoção de vínculo de empresa/Cliente |
| customer | customer-groups | Grupos de clientes |
| customer | customer-histories | Histórico do cadastro do Cliente |
| customer | customer-identification-documents | Documentos do cliente |
| customer | customer-person-types | Tipo de pessoa (Física/Juridica/Outros)|
| customer | customers | Clientes e subentidades |
| customer | emails | Emails do cliente/lead/contato |
| customer | lead-companies-unlink* | Remoção do vínculo de empresa/Lead |
| customer | lead-histories | Histórico do cadastro do Lead |
| customer | lead-identification-documents | Documentos do lead |
| customer | lead-origins | Origem do lead |
| customer | lead-situations | Situação do lead |
| customer | lead-stages | Estágio do lead |
| customer | leads | Leads |
| customer | location-business-lines | Ramo de atividade |
| customer | lock-types | Tipos de bloqueio |
| customer | phones | Telefones do cliente/lead/contato |

**Financial** - Dados financeiros do cliente

| Serviço | API de integração | Descritivo |
| -------- | ------------------- | --------------------- |
| financial | credit-limits | Limites de credito |
| financial | financial-securities | Títulos financeiros |
| financial | status | Status dos títulos |

**Opportunity** - Oportunidade, atividades e vínculos

| Serviço | API de integração | Descritivo |
| ----------- |-------------------------------|---------------------------------------|
| opportunity | action-plan-route-activities | Atividades dentro das rotas |
| opportunity | action-plan-routes | Vínculo do plano de ação com rotas |
| opportunity | action-plan-users | Vínculo do plano de ação com usuários |
| opportunity | action-plans | Planos de ação |
| opportunity | activities | Atividades |
| opportunity | activity-types | Tipos de atividade |
| opportunity | opportunities | Oportunidades |
| opportunity | opportunity-items | Itens da oportunidade |
| opportunity | opportunity-team-members | Membros da oportunidade |
| opportunity | opportunity-types | Tipos de oportunidade |
| opportunity | origins | Origens de oportunidade |
| opportunity | pipeline-stages | Vínculo das etapas com o funil |
| opportunity | pipelines | Funil de oportunidades |
| opportunity | stages | Etapa do funil |
| opportunity | win-loss-reasons | Motivos de venda/perda |

**Product** - Produto e serviço

| Serviço | API de integração | Descritivo |
| --------- | ------------------------------ | ------------------------------------------------- |
| product | bundle-products | Produtos do pacote |
| product | bundle-services | Serviços do pacote |
| product | bundles | Cabeçalho do pacote de produto/serviço |
| product | manufacturers | Fabricantes |
| product | price-list-company-permission | Vínculo de tabela de preço e filial |
| product | price-list-customer-permission | Vínculo de tabela de preço e cliente |
| product | price-list-items | Itens de tabela de preço |
| product | price-list-payment-methods | Vínculo de tabela de preço e forma de pagamento |
| product | price-list-payment-terms | Vínculo de tabela de preço e condição de pagamento|
| product | price-list-region-permission | Vínculo de tabela de preço e região física |
| product | price-list-user-permission | Vínculo de tabela de preço e usuário |
| product | price-lists | Cabeçalho de tabelas de preço |
| product | groups | Grupos de produto |
| product | product-companies-unlink* | Remoção de vínculo de empresa/Produto |
| product | product-inventories | Estoque de produtos |
| product | product-packagings | Embalagens de produto |
| product | products | Produtos |
| product | service-companies-unlink* | Remoção de vínculo de empresa/Serviço |
| product | service-groups | Grupos de serviço |
| product | services | Serviços |
| product | suppliers | Fornecedores |

**Sales** - Ordens de venda e relacionadas

| Serviço | API de integração | Descritivo |
| ------- | --------------------------------- | ------------------------------------------ |
| sales | carrier-customers | Vínculo de transportadora e cliente |
| sales | carriers | Transportadora |
| sales | deliveries | Entrega da ordem de venda |
| sales | freight-types | Tipos de frete |
| sales | installments | Parcelas da ordem |
| sales | order-products | Itens da ordem de venda - produtos |
| sales | order-services | Itens da ordem de venda - serviços |
| sales | order-status | Status da ordem |
| sales | order-types | Tipos de ordem |
| sales | orders | Ordens de venda |
| sales | payment-methods | Forma de pagamento |
| sales | payment-term-company-permission | Vínculo da condição de pagamento e filial |
| sales | payment-term-customer-permission | Vínculo da condição de pagamento e cliente |
| sales | payment-term-user-permission | Vínculo da condição de pagamento e usuários|
| sales | payment-terms | Condição de pagamento |

**User** - Profissional de vendas

| Serviço | API de integração | Descritivo |
| ------- | -------------------------- | ------------------------ |
| user | hierarchy-relationships | Hierarquia de usuário |
| user | profiles | Perfis de usuário |
| user | roles | Papéis de usuário |
| user | user-emails | Emails do usuário |
| user | user-phones | Telefones do usuário |
| user | users | Usuários/Profissionais |

---

# Documentação das APIs de Marketplace do MasterCRM

## Captura de Leads

A documentação das APIs para utilização da funcionalidade de 'Captura de leads' do Marketplace do MasterCRM está disponível em:

marketplace > lead-capture > lead-capture-openapi.yaml