Conta (Account)

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

Tipos de registro

Rótulo tipo de registro	Nome de API	Descrição
Franqueado	Franqueado
Agência de publicidade	Agencia_publicidade
Fiador	Fiador
Locador	Locador
Marca	marca

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

Campos da Conta

Rótulo do campo	Nome de API	Tipo de dado	Obrigatório	Descrição
Nome da conta	Name	Texto	X	Nome que a conta possuí Obrigatório para todos os tipos de registros
Classificação	Rating	Lista de opções		Opções possíveis: Hot Warm Cold
Código SIC	Sic	Texto(20)
Conta pai	Parent	Pesquisa(Conta)/Id		Id da conta pai ou Id externo da conta pai
Descrição	Description	Área de texto longo(32000)
Descrição SIC	SicDesc	Texto(80)
País de cobrança	BillingCountryCode	Lista de opções		Lista de países *
Rua de cobrança	BillingStreet	Texto		Nome da rua + número
Cidade de cobrança	BillingCity	Texto
Estado/Província de cobrança	BillingStateCode	Lista de opções		Lista de estados *
CEP de cobrança	BillingPostalCode	Texto
País de entrega	ShippingCountryCode	Lista de opções		Lista de países *
Rua de entrega	ShippingStreet	Texto		Nome da rua + número
Cidade de entrega	ShippingCity	Texto
Estado/Província de entrega	ShippingStateCode	Lista de opções/Texto		Lista de estados *
CEP de entrega	ShippingPostalCode	Texto
Fax	Fax	Texto
Funcionários	NumberOfEmployees	Número(8, 0)
Local da conta	Site	Texto(80)
Número da conta	AccountNumber	Texto(40)
Origem da conta	AccountSource	Lista de opções		Opções possíveis: Web Phone Inquiry Partner Referral Purchased List Other
Propriedade	Ownership	Lista de opções		Opções possíveis: Public Private Subsidiary Other
Proprietário da conta	Owner	Pesquisa(Usuário)/Id	X	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 anual	AnnualRevenue	Moeda (18,0)
Setor	Industry	Lista 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 marcador	TickerSymbol	Texto(20)
Site da Web	Website	URL(255)
Telefone	Phone	Texto
Tipo	Type	Lista de opções		Opções possíveis: Franqueador Franqueado
Tipo de registro da conta	RecordType	Id/Texto	X	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 publicidade	snap_mall__Agencia_publicidade__c	Pesquisa(Conta)
Aprovada	snap_mall__Aprovada__c	Caixa de seleção		Opções possíveis: true false
Área de atuação	snap_mall__area_atuacao__c	Lista de opções		Opções possíveis: Nacional Regional Local
Atividade	snap_mall__atividade_sap__c	Pesquisa(Atividade)		Id da atividade
Categoria	snap_mall__Categoria__c	Pesquisa(Categoria)		Id da categoria
Classe social	snap_mall__classe_social__c	Lista de opções		Opções possíveis: A B C Todas
CNPJ	snap_mall__CNPJ__c	Texto(18)
Contato comercial	snap_mall__Contato_comercial__c	Pesquisa(Contato)		Id do contato
Customer Priority	snap_mall__CustomerPriority__c	Lista de opções		Opções possíveis: High Low Medium
Estilo	snap_mall__estilo__c	Lista de opções		Opções possíveis: Casual Fashion Clássico
Finalidade	snap_mall__finalidade_2__c	Área de texto longo(2000)
Franquia	snap_mall__franquia__c	Caixa de seleção		Opções possívies: true false
Fundo de investimento	snap_mall__fundo_investimento__c	Pesquisa(Fundo de investimento)		Id do fundo de investimento
Grupo	snap_mall__grupo_sap__c	Pesquisa(Grupo)		Id do Grupo
Grupo econômico	snap_mall__grupo_economico__c	Pesquisa(Grupo econômico)		Id do Grupo econômico
Id externo	snap_mall__id_externo__c	Texto(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 estadual	snap_mall__Inscricao_estadual__c	Texto(15)
Inscrição municipal	snap_mall__Inscricao_municipal__c	Texto(30)
Number of Locations	snap_mall__NumberofLocations__c	Número(3, 0)
Razão social	snap_mall__Razao_social__c	Texto(100)
Situalção	snap_mall__Situacao__c	Lista de opções		Opções possíveis: Rascunho (padrão de uma nova conta) Em aprovação Aprovada Reprovada
SLA	snap_mall__SLA__c	Lista de opções		Opções possíveis: Gold Silver Platinum Bronze
SLA Expiration Date	snap_mall__SLAExpirationDate__c	Data		Exemplo: 2018-04-23
SLA Serial Number	snap_mall__SLASerialNumber__c	Texto(10)
Subgrupo	snap_mall__subgrupo_sap__c	Pesquisa(Subgrupo)		Id do subgrupo
Upsell Opportunity	snap_mall__UpsellOpportunity__c	Lista de opções		Opções poossíveis: Maybe No Yes

Criar Franqueado:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/

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:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/

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

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/

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

Request

{
"Name":"Agência - EFO - Publicando",
"RecordType":{"Name":"Fiador"},
"snap_mall__id_externo__c":"33333",
"snap_mall__Contato_comercial__c":"0031J00001MNYJ4",
"snap_mall__Categoria__c":"a0A1J00001FFviFUAT",
"Rating":"Warm",
"ParentId":"0011J00001DtTOr",
"OwnerId":"0051J000004ppUV",
"Phone":"+551188888888",
"Fax":"+55116666666",
"Website":"www.google.com.br",
"snap_mall__CNPJ__c":"31562704000181",
"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",
"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": "0011J00001DwIAJQA3", "success": true, "errors": [] }

Criar Locador:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/

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

Request

{
"Name":"Locador - EFO",
"RecordType":{"Name":"Locador"},
"OwnerId":"0051J000004ppUV",
"ParentId":"0011J00001DtTOr",
"snap_mall__Situacao__c":"Rascunho",
"snap_mall__Aprovada__c":"true",
"snap_mall__Agencia_publicidade__c":"0011J00001DwI9T",
"snap_mall__franquia__c":"false",
"snap_mall__grupo_economico__c":"a0M1J00000DSkmZUAT",
"snap_mall__grupo_sap__c":"a0E1J00000KdqA5UAJ",
"snap_mall__fundo_investimento__c":"a0F1J0000128WAvUAM",
"snap_mall__subgrupo_sap__c":"a0H1J00000L0E2yUAF",
"snap_mall__area_atuacao__c":"Regional",
"snap_mall__atividade_sap__c":"a0G1J00003FZCb7UAH",
"snap_mall__classe_social__c":"B",
"snap_mall__estilo__c":"Casual,",
"snap_mall__Contato_comercial__c":"0031J00001MNYJ4",
"Phone":"+551188888888",
"Website":"www.google.com.br",
"Fax":"+55116666666",
"snap_mall__CNPJ__c":"54604986000138",
"snap_mall__Inscricao_estadual__c":"111111",
"snap_mall__Razao_social__c":"Locador - EFO",
"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",
"snap_mall__id_externo__c":"5555555",
"Ownership":"Public",
"Type":"Franqueado",
"Rating":"Warm",
"AccountSource":"Web",
"NumberOfEmployees":"10",
"snap_mall__Categoria__c":"a0A1J00001FFviFUAT",
"Industry":"Agricultaure",
"AnnualRevenue":"250000",
"Site":"www.google.com",
"Description":"Conta de teste",
"snap_mall__finalidade_2__c":"Conta de teste"
}

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

Criar Marca:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/

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

Request

{
"Name":"Marca Teixeirinha - EFO",
"RecordType":{"Name":"Marca"},
"OwnerId":"0051J000004ppUV",
"ParentId":"0011J00001DtTOr",
"snap_mall__Situacao__c":"Rascunho",
"snap_mall__Aprovada__c":"true",
"snap_mall__Agencia_publicidade__c":"0011J00001DwI9T",
"snap_mall__franquia__c":"false",
"snap_mall__grupo_economico__c":"a0M1J00000DSkmZUAT",
"snap_mall__grupo_sap__c":"a0E1J00000KdqA5UAJ",
"snap_mall__fundo_investimento__c":"a0F1J0000128WAvUAM",
"snap_mall__subgrupo_sap__c":"a0H1J00000L0E2yUAF",
"snap_mall__area_atuacao__c":"Regional",
"snap_mall__atividade_sap__c":"a0G1J00003FZCb7UAH",
"snap_mall__classe_social__c":"B",
"snap_mall__estilo__c":"Casual,",
"snap_mall__Contato_comercial__c":"0031J00001MNYJ4",
"Phone":"+551188888888",
"Website":"www.google.com.br",
"Fax":"+55116666666",
"snap_mall__CNPJ__c":"98169572000101",
"snap_mall__Inscricao_estadual__c":"111111",
"snap_mall__Razao_social__c":"Marca Teixeirinha - EFO",
"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",
"snap_mall__id_externo__c":"999999",
"Ownership":"Public",
"Type":"Franqueado",
"Rating":"Warm",
"AccountSource":"Web",
"NumberOfEmployees":"10",
"snap_mall__Categoria__c":"a0A1J00001FFviFUAT",
"Industry":"Agricultaure",
"AnnualRevenue":"250000",
"Site":"www.google.com",
"Description":"Conta de teste marca",
"snap_mall__finalidade_2__c":"Conta de teste marca"
}

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

Atualizar Conta:

Método : PATCH

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/ (Id do registro salesforce)

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/snap_mall__id_externo__c/ (Id externo)

Descrição:

Método de atualização de uma conta(Account) de qualquer tipo, informando no body apenas os campos que se deseja atualizar. Lembrando que devem ser informados apenas campos pertinentes ao tipo de registro escolhido (Franqueado,Agência de publicidade, Fiador, Locador, Marca).

Existem duas possibilidades de atualização da Conta: 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:

Método : DELETE

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/ (Id do registro salesforce)

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/Account/snap_mall__id_externo__c/ (Id externo)

Descrição: Método de deleção de uma conta(Account) de qualquer tipo. Existem duas possibilidades de deleção da Conta : Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

Request

Body de deleção é vazio.

Response

Response de deleção retorna vazio.