Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Possuem cinco tipos de contas (Tipo de registro), que terão suas particulares obrigatoriedades, e que serão delimitados seus métodos individualmente. 

...

Está informação dos tipos de registros é importante, pois para o cadastro e atualização de cada conta, dependendo do tipo de registro de contas, existem diferentes campos a serem obrigatoriamente    obrigatoriamente informados,e campos que podem ser informados ou não. 

...

Rótulo do campoNome de APITipo de dadoObrigatórioDescrição
Nome da contaNameTextoX
  • Nome que a conta possuí
  • Obrigatório para todos os tipos de registros
ClassificaçãoRatingLista de opções

Opções possíveis:

  • Hot
  • Warm
  • Cold
Código SICSicTexto(20)

Conta paiParentPesquisa(Conta)/Id
Id da conta pai ou Id externo da conta pai
DescriçãoDescriptionÁrea de texto longo(32000)

Descrição SICSicDescTexto(80)

País de cobrançaBillingCountryCodeLista de opções
Lista de países *
Rua de cobrançaBillingStreetTexto
Nome da rua + número 
Cidade de cobrançaBillingCityTexto

Estado/Província de cobrançaBillingStateCodeLista de opções
Lista de estados *
CEP de cobrançaBillingPostalCodeTexto

País de entregaShippingCountryCodeLista de opções
Lista de países *
Rua de entregaShippingStreetTexto
Nome da rua + número 
ShippingCityTexto

ShippingStateCodeLista de opções/Texto
Lista de estados *
CEP de entregaShippingPostalCodeTexto

FaxFaxTexto

FuncionáriosNumberOfEmployeesNúmero(8, 0)

Local da contaSiteTexto(80)

Número da contaAccountNumberTexto(40)

Origem da contaAccountSourceLista de opções

Opções possíveis:

  • Web
  • Phone Inquiry
  • Partner Referral
  • Purchased List
  • Other
PropriedadeOwnershipLista de opções

Opções possíveis:

  • Public
  • Private
  • Subsidiary
  • Other
Proprietário da contaOwnerPesquisa(Usuário)/IdX
  • Id do usuário que será proprietário da conta. Caso não for informado nenhum,o proprietário original será usuário da integração.
  • Se não for preenchido será o usuário de integração;
Receita anualAnnualRevenueMoeda (18,0)

Setor IndustryLista de opções

Opções possíveis:

  • Agriculture
  • Apparel
  • Banking
  • Biotechnology
  • Chemicals
  • Communications
  • Construction
  • Consulting
  • Education
  • Electronics
  • Energy
  • Engineering
  • Environmental
  • Finance
  • Food & Beverage
  • Government
  • Healthcare
  • Hospitality
  • Insurance
  • Machinery
  • Manufacturing
  • Media
  • Not For Profit
  • Recreation
  • Retail
  • Shipping
  • Technology
  • Telecommunications
  • Transportation
  • Utilities
  • Other
Símbolo do marcadorTickerSymbolTexto(20)

Site da WebWebsiteURL(255)

TelefonePhoneTexto

TipoTypeLista de opções 

Opções possíveis:

  • Franqueador
  • Franqueado
Tipo de registro da contaRecordTypeId/TextoX
  • Id do Tipo de registro ou Nome de API do tipo de registro *
  • Necessário informar o tipo de registro no cadastro
Agência de publicidadesnap_mall__Agencia_publicidade__cPesquisa(Conta)

Aprovadasnap_mall__Aprovada__cCaixa de seleção

Opções possíveis:

  • true
  • false
Área de atuaçãosnap_mall__area_atuacao__cLista de opções

Opções possíveis:

  • Nacional
  • Regional
  • Local
Atividadesnap_mall__atividade_sap__cPesquisa(Atividade)
Id da atividade
Categoriasnap_mall__Categoria__cPesquisa(Categoria)
Id da categoria
Classe socialsnap_mall__classe_social__cLista de opções

Opções possíveis:

  • A
  • B
  • C
  • Todas
CNPJsnap_mall__CNPJ__cTexto(18)

Contato comercialsnap_mall__Contato_comercial__cPesquisa(Contato)
Id do contato
Customer Prioritysnap_mall__CustomerPriority__cLista de opções

Opções possíveis:

  • High
  • Low
  • Medium
Estilosnap_mall__estilo__cLista de opções

Opções possíveis:

  • Casual
  • Fashion
  • Clássico
Finalidadesnap_mall__finalidade_2__cÁrea de texto longo(2000)

Franquiasnap_mall__franquia__cCaixa de seleção

Opções possívies:

  • true
  • false
Fundo de investimentosnap_mall__fundo_investimento__cPesquisa(Fundo de investimento)
Id do fundo de investimento
Gruposnap_mall__grupo_sap__cPesquisa(Grupo)
Id do Grupo
Grupo econômicosnap_mall__grupo_economico__cPesquisa(Grupo econômico)
Id do Grupo econômico
Id externosnap_mall__id_externo__cTexto(80)
Id do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste Id.
Inscrição estadualsnap_mall__Inscricao_estadual__cTexto(15)

Inscrição municipalsnap_mall__Inscricao_municipal__cTexto(30)

Number of Locationssnap_mall__NumberofLocations__cNúmero(3, 0)

Razão socialsnap_mall__Razao_social__cTexto(100)

Situalçãosnap_mall__Situacao__cLista de opções

Opções possíveis:

  • Rascunho (padrão de uma nova conta)
  • Em aprovação
  • Aprovada
  • Reprovada
SLAsnap_mall__SLA__cLista de opções

Opções possíveis:

  • Gold
  • Silver
  • Platinum
  • Bronze
SLA Expiration Datesnap_mall__SLAExpirationDate__cData
Exemplo: 2018-04-23
SLA Serial Numbersnap_mall__SLASerialNumber__cTexto(10)

Subgruposnap_mall__subgrupo_sap__cPesquisa(Subgrupo)
Id do subgrupo
Upsell Opportunitysnap_mall__UpsellOpportunity__cLista de opções

Opções poossíveis:

  • Maybe
  • No
  • Yes

...

                 Descrição: Método de criação de uma conta(Account) do tipo Franqueado, informando todos os campos utilizados para um Franqueado.


Request

{
"Name":"Franqueado - EFO - Teste",
"RecordType":{"Name":"Franqueado"},
"snap_mall__id_externo__c":"12345678",
"snap_mall__Contato_comercial__c":"0031J00001MNYJ4",
"OwnerId":"0051J000004ppUV",
"Type":"Franqueado",
"Rating":"Hot",
"snap_mall__Categoria__c":"a0A1J00001FFviFUAT",
"Phone":"+5511222222222",
"Parent":{"snap_mall__id_externo__c":"40028922"},
"Fax":"+55113333333",
"snap_mall__Situacao__c":"Rascunho",
"snap_mall__Aprovada__c":"false",
"snap_mall__CNPJ__c":"94491071000199",
"snap_mall__Inscricao_estadual__c":"123456",
"snap_mall__Razao_social__c":"Franqueado - EFO - Razão",
"snap_mall__Inscricao_municipal__c":"78911011",
"BillingStreet": "Avenida Paulista, 2300",
"BillingCity": "São Paulo",
"BillingStateCode": "SP",
"BillingPostalCode": "01311300",
"BillingCountryCode":"BR",
"ShippingStreet": "Avenida Paulista, 2300",
"ShippingCity": "São Paulo",
"ShippingStateCode": "SP",
"ShippingPostalCode": "01311300",
"ShippingCountryCode":"BR",
"AccountSource":"Web",
"Ownership":"Public",
"Site":"www.google.com",
"NumberOfEmployees":"10",
"AnnualRevenue":"150000",
"Sic":"01234",
"Industry":"Agriculture",
"TickerSymbol":"Teste",
"snap_mall__CustomerPriority__c":"Low",
"snap_mall__SLA__c":"Gold",
"snap_mall__SLAExpirationDate__c":"2018-10-16",
"snap_mall__SLASerialNumber__c":"123456",
"snap_mall__NumberofLocations__c":"3",
"snap_mall__UpsellOpportunity__c":"Yes",
"Description":"Conta de teste",
"snap_mall__finalidade_2__c":"Conta de teste"
}



Response

{
"id": "0011J00001DwHQDQA3",
"success": true,
"errors": []
}



         Criar Agência de Publicidade:

...

                 Descrição: Método de criação de uma conta(Account) do tipo Agência de publicidade, informando todos os campos utilizados para uma Agência de publicidade.


Request

{
"Name":"Agência - EFO - Publicando",
"RecordTypeId":"0121J000001DbbP",
"snap_mall__id_externo__c":"111111",
"snap_mall__Contato_comercial__c":"0031J00001MNYJ4",
"OwnerId":"0051J000004ppUV",
"snap_mall__Categoria__c":"a0A1J00001FFviFUAT",
"Rating":"Warm",
"Fax":"+55116666666",
"Website":"www.google.com.br",
"snap_mall__CNPJ__c":"07935315000170",
"snap_mall__Inscricao_estadual__c":"111111",
"snap_mall__Razao_social__c":"Agência - Publicando",
"snap_mall__Inscricao_municipal__c":"2222222",
"BillingStreet": "Avenida Paulista, 2300",
"BillingCity": "São Paulo",
"BillingStateCode": "SP",
"BillingPostalCode": "01311300",
"ShippingStreet": "Avenida Paulista, 2300",
"ShippingCity": "São Paulo",
"ShippingStateCode": "SP",
"ShippingPostalCode": "01311300",
"AccountSource":"Web",
"Ownership":"Public",
"Site":"www.google.com",
"NumberOfEmployees":"10",
"AnnualRevenue":"150000",
"Sic":"01234",
"Industry":"Agriculture",
"Type":"Franqueado",
"TickerSymbol":"Agencia",
"Phone":"+551188888888",
"snap_mall__CustomerPriority__c":"Low",
"snap_mall__SLA__c":"Gold",
"snap_mall__SLAExpirationDate__c":"2018-10-16",
"snap_mall__SLASerialNumber__c":"123456",
"snap_mall__NumberofLocations__c":"3",
"snap_mall__UpsellOpportunity__c":"Yes",
"Description":"Conta de teste",
"snap_mall__finalidade_2__c":"Conta de teste"
}



Response

{
"id": "0011J00001DwI9TQAV",
"success": true,
"errors": []
}



          Criar Fiador:

                 Método : POST

...

         Existem duas possibilidades de atualização da Conta do tipo Franqueado: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

                O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body. 


Request

{
"Name":"Franqueado - EFO - Atualizado",
"Rating":"Warm",
"snap_mall__UpsellOpportunity__c":"No"
}


Response

   Response em caso de sucesso da atualização retornará vazio.

               

Deletar Conta:

...