POST servico/integracaoterceiros/CadastroGeral
Inclui um cadastro geral no ERP.
Request Info
URI Parameters
None.
Body Parameters
DTO de Cadastro Geral
DTODeCadastroGeralIntegracaoNovo| Nome | Descrição | Tipo | Informações adicionais |
|---|---|---|---|
| id |
Código de cadastro |
integer |
Range: inclusive between 0 and 999999 |
| UtilizaSequenciaDaAtak |
Define se mantem o ID do sistema de terceiro ou utiliaz a sequencia do tipo de cadastro da Atak. Se definido o valor como TRUE e informado um ID do sistema de terceiro, no campo ID, o mesmo será gravado em um campo auxiliar, Cod_sistema_terceiro. |
boolean |
Required |
| tipoDeCadastro |
Tipo de cadastro válido no ERPAtak |
string |
Required String length: inclusive between 1 and 1 |
| CodigoDaFilial |
Código da filial do cadastro. Se não for informado será utilizado a filial padrão 001. |
string |
Required String length: inclusive between 0 and 3 |
| codigoDaArea |
Código da área válida no ERPAtak. Caso não informado, código de área padrão configurado será utilizado, caso exista. |
string |
String length: inclusive between 0 and 3 |
| RazaoSocial |
Razão Social |
string |
Required String length: inclusive between 1 and 60 |
| nomeFantasia |
Nome fantasia |
string |
Required String length: inclusive between 1 and 50 |
| tipoDePessoa |
Tipo de pessoa [F | J] |
string |
Required String length: inclusive between 1 and 1 |
| cpfCnpj |
CPF ou CNPJ |
string |
None. |
| rg |
RG |
string |
String length: inclusive between 0 and 14 |
| identificadorEstadual |
identificador Estadua: [0 = Não aplicável | 1 = Contribuinte ICMS | 2 = Contribuinte Isento | 9 = Não Contribuinte] |
EnumIndicadorDaIE |
None. |
| observacao |
Observação |
string |
None. |
| codigoDaSituacao |
Codigo da situação [ A = Ativo | B = Bloqueado | I = Inativo ] |
string |
None. |
| codigoDoRamoDaAtividade |
Código do ramo de atividade, válido no ERPAtak. Caso não informado, código de ramo de atividade padrão configurado será utilizado, caso exista. |
string |
None. |
| codigoDoPercursoDaRotaDeEntrega |
Código do percurso, válido no ERPAtak, da rota de entrega. |
string |
None. |
| ordemDoPercursoParaEntrega |
Ordem de entrega do percurso |
integer |
None. |
| distanciaDaEmpresaAoLocalDaEntrega |
Distancia da empresa ao local de entrega |
integer |
None. |
| uf |
UF |
string |
String length: inclusive between 0 and 2 |
| indicadorMicroEmpresa |
Indicador de micro empresa. |
string |
String length: inclusive between 0 and 1 |
| suframa |
Suframa |
string |
String length: inclusive between 0 and 9 |
| Enderecos |
Endereços do cadastro geral. O endereço de faturamento é obrigatório. |
DTODeEnderecosIntegracao |
None. |
| Financeiro |
DTO de dados financeiros do cadastro geral. |
DTODeCadastroGeralFinanceiroIntegracao |
None. |
| PercentualDeComissaoDoVendedor |
Precentual de comissão do vendedor. |
decimal number |
None. |
| TipoDoVendedor |
Tipo do vendedor. |
string |
String length: inclusive between 1 and 1 |
| TipoDaComissaoDoVendedor |
Tipo da comissão do vendedor. [ V = Venda | R = Recebimento ] |
string |
String length: inclusive between 1 and 1 |
| PercentualDescontoMaxDaVenda |
Percentual de desconto máximo da venda. |
decimal number |
None. |
| CodigoDoSupervisorDaVenda |
Código do supervisor de venda. Cadastro geral válido no ERPAtak. |
integer |
None. |
| CodigoDoGerenteDaVenda |
Código do gerente de venda. Cadastro geral válido no ERPAtak. |
integer |
None. |
| CodigoSistemaAnterior |
Código sistema anterior |
string |
String length: inclusive between 0 and 20 |
| DataV1 |
Data Auxiliar V1 |
date |
None. |
| DataV2 |
Data Auxiliar V2 |
date |
None. |
| IDLocalEstoque |
Código do Local de Estoque |
string |
String length: inclusive between 0 and 4 |
| idDaCondicaoDePagamento |
Código da Condição de Pagamento |
string |
String length: inclusive between 0 and 4 |
| ObservacaoCadObs |
Observação persistida na tbCadastrogObs |
string |
None. |
| CodigoPerfilTributario |
Código do Perfil Tributário do Participante |
integer |
None. |
| DataCadastro | date |
None. |
|
| DataV3 |
Data versão 3 do cadastro geral |
date |
None. |
| CampoV1 |
Campo versão 1 |
string |
String length: inclusive between 0 and 50 |
| CampoV2 |
Campo versão 2 |
string |
String length: inclusive between 0 and 50 |
| CampoV3 |
Campo versão 3 |
string |
String length: inclusive between 0 and 50 |
| CampoV4 |
Campo versão 4 |
string |
String length: inclusive between 0 and 50 |
| CampoV5 |
Campo versão 5 |
string |
String length: inclusive between 0 and 50 |
| CampoV6 |
Campo versão 6 |
string |
String length: inclusive between 0 and 50 |
| MercadosHabilitados |
Mercados Habilitados. Em caso de POST ou PUT, se informar mais de um Mercado Habilitado, separar por virgula. |
string |
None. |
| IdTipoMovimentoFaturamentoSaida |
Código do tipo de movimento para faturamento do tipo saída |
string |
String length: inclusive between 0 and 4 |
| IdTipoMovimentoFaturamentoEntrada |
Código do tipo de movimento para faturamento do tipo entrada |
string |
String length: inclusive between 0 and 4 |
| PercentualRedutorDeComissao | decimal number |
None. |
|
| RGIE | string |
None. |
Request Formats
application/json, text/json
{
"id": 1,
"UtilizaSequenciaDaAtak": true,
"tipoDeCadastro": "sample string 2",
"CodigoDaFilial": "sample string 3",
"codigoDaArea": "sample string 4",
"RazaoSocial": "sample string 5",
"nomeFantasia": "sample string 6",
"tipoDePessoa": "sample string 7",
"cpfCnpj": "sample string 8",
"rg": "sample string 9",
"identificadorEstadual": 0,
"observacao": "sample string 10",
"codigoDaSituacao": "sample string 11",
"codigoDoRamoDaAtividade": "sample string 12",
"codigoDoPercursoDaRotaDeEntrega": "sample string 13",
"ordemDoPercursoParaEntrega": 1,
"distanciaDaEmpresaAoLocalDaEntrega": 1,
"uf": "sample string 14",
"indicadorMicroEmpresa": "sample string 15",
"suframa": "sample string 16",
"Enderecos": {
"IdDoPaisF": "sample string 1",
"UFF": "sample string 2",
"ConteudoEnderecoF": "sample string 3",
"BairroF": "sample string 4",
"CodigoIBGECidadeF": "sample string 5",
"CidadeF": "sample string 6",
"TelefoneF": "samplestring7",
"FaxF": "samplestring8",
"EmailF": "sample string 9",
"CEPF": "sample string 10",
"NumeroF": "sample string 11",
"ObservacaoF": "sample string 12",
"LatitudeF": "sample string 13",
"LongitudeF": "sample string 14",
"IdDoPaisC": "sample string 15",
"UFC": "sample string 16",
"ConteudoEnderecoC": "sample string 17",
"BairroC": "sample string 18",
"CodigoIBGECidadeC": "sample string 19",
"CidadeC": "sample string 20",
"TelefoneC": "samplestring21",
"FaxC": "samplestring22",
"EmailC": "sample string 23",
"CEPC": "sample string 24",
"ObservacaoC": "sample string 25",
"NumeroC": "sample string 26",
"LatitudeC": "sample string 27",
"LongitudeC": "sample string 28",
"IdDoPaisE": "sample string 29",
"UFE": "sample string 30",
"ConteudoEnderecoE": "sample string 31",
"BairroE": "sample string 32",
"CodigoIBGECidadeE": "sample string 33",
"CidadeE": "sample string 34",
"TelefoneE": "samplestring35",
"FaxE": "samplestring36",
"EmailE": "sample string 37",
"CEPE": "sample string 38",
"ObservacaoE": "sample string 39",
"NumeroE": "sample string 40",
"LatitudeE": "sample string 41",
"LongitudeE": "sample string 42",
"IdDoPaisR": "sample string 43",
"UFR": "sample string 44",
"ConteudoEnderecoR": "sample string 45",
"BairroR": "sample string 46",
"CodigoIBGECidadeR": "sample string 47",
"CidadeR": "sample string 48",
"TelefoneR": "samplestring49",
"FaxR": "samplestring50",
"EmailR": "sample string 51",
"CEPR": "sample string 52",
"ObservacaoR": "sample string 53",
"NumeroR": "sample string 54",
"LatitudeR": "sample string 55",
"LongitudeR": "sample string 56",
"IdDoPaisT": "sample string 57",
"UFT": "sample string 58",
"ConteudoEnderecoT": "sample string 59",
"BairroT": "sample string 60",
"CodigoIBGECidadeT": "sample string 61",
"CidadeT": "sample string 62",
"TelefoneT": "samplestring63",
"FaxT": "samplestring64",
"EmailT": "sample string 65",
"CEPT": "sample string 66",
"ObservacaoT": "sample string 67",
"NumeroT": "sample string 68",
"LatitudeT": "sample string 69",
"LongitudeT": "sample string 70"
},
"Financeiro": {
"CodigoDaListaDePreco": 1,
"GrupoEmpresarial": 1,
"CodigoDeRisco": 1,
"PercentualDeDesconto": 1.0,
"DataDaUltimaCompra": "2026-04-05T10:29:32.9654109-03:00",
"ValorDaUltimaCompra": 1.0,
"ValorDaMaiorCompra": 1.0,
"ValorDoLimiteDeCredito": 1.0,
"CodigoDaMoeda": 1,
"CodigoDoVendedor": 1,
"CodigoDaCarteira": 1,
"DataRenovacaoDoCredito": "2026-04-05T10:29:32.9654109-03:00",
"ConsumidorFinal": "sample string 1",
"PrazoMaximoDeAtraso": 1,
"SubstitutoTributario": "sample string 2",
"PercentualDeSubstituicaoTributaria": 1.0,
"PrazoMedioMaximo": 1,
"CodigoFormaDeCobranca": 1,
"PrazoMedioDeCompra": 1,
"ValorMedioDeCompra": 1.0,
"MediaDeAtrasoNoPagamento": 1,
"CodigoDoTransportador1": 1,
"CodigoDoTransportador2": 1
},
"PercentualDeComissaoDoVendedor": 17.0,
"TipoDoVendedor": "sample string 18",
"TipoDaComissaoDoVendedor": "sample string 19",
"PercentualDescontoMaxDaVenda": 20.0,
"CodigoDoSupervisorDaVenda": 1,
"CodigoDoGerenteDaVenda": 1,
"CodigoSistemaAnterior": "sample string 21",
"DataV1": "2026-04-05T10:29:32.9654109-03:00",
"DataV2": "2026-04-05T10:29:32.9654109-03:00",
"IDLocalEstoque": "sample string 22",
"idDaCondicaoDePagamento": "sample string 23",
"ObservacaoCadObs": "sample string 24",
"CodigoPerfilTributario": 1,
"DataCadastro": "2026-04-05T10:29:32.9654109-03:00",
"DataV3": "2026-04-05T10:29:32.9654109-03:00",
"CampoV1": "sample string 25",
"CampoV2": "sample string 26",
"CampoV3": "sample string 27",
"CampoV4": "sample string 28",
"CampoV5": "sample string 29",
"CampoV6": "sample string 30",
"MercadosHabilitados": "sample string 31",
"IdTipoMovimentoFaturamentoSaida": "sample string 32",
"IdTipoMovimentoFaturamentoEntrada": "sample string 33",
"PercentualRedutorDeComissao": 1.0,
"RGIE": "sample string 34"
}
application/xml, text/xml
<DTODeCadastroGeralIntegracaoNovo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATAK.DTO.API.Integracao.CadastroGeral">
<CampoV1>sample string 25</CampoV1>
<CampoV2>sample string 26</CampoV2>
<CampoV3>sample string 27</CampoV3>
<CampoV4>sample string 28</CampoV4>
<CampoV5>sample string 29</CampoV5>
<CampoV6>sample string 30</CampoV6>
<CodigoDaArea>sample string 4</CodigoDaArea>
<CodigoDaSituacao>sample string 11</CodigoDaSituacao>
<CodigoDoGerenteDaVenda>1</CodigoDoGerenteDaVenda>
<CodigoDoPercursoDaRotaDeEntrega>sample string 13</CodigoDoPercursoDaRotaDeEntrega>
<CodigoDoRamoDaAtividade>sample string 12</CodigoDoRamoDaAtividade>
<CodigoDoSupervisorDaVenda>1</CodigoDoSupervisorDaVenda>
<CodigoPerfilTributario>1</CodigoPerfilTributario>
<CodigoSistemaAnterior>sample string 21</CodigoSistemaAnterior>
<CpfCnpj>sample string 8</CpfCnpj>
<DataCadastro>2026-04-05T10:29:32.9654109-03:00</DataCadastro>
<DataV1>2026-04-05T10:29:32.9654109-03:00</DataV1>
<DataV2>2026-04-05T10:29:32.9654109-03:00</DataV2>
<DataV3>2026-04-05T10:29:32.9654109-03:00</DataV3>
<DistanciaDaEmpresaAoLocalDaEntrega>1</DistanciaDaEmpresaAoLocalDaEntrega>
<Enderecos>
<BairroC>sample string 18</BairroC>
<BairroE>sample string 32</BairroE>
<BairroF>sample string 4</BairroF>
<BairroR>sample string 46</BairroR>
<BairroT>sample string 60</BairroT>
<CEPC>sample string 24</CEPC>
<CEPE>sample string 38</CEPE>
<CEPF>sample string 10</CEPF>
<CEPR>sample string 52</CEPR>
<CEPT>sample string 66</CEPT>
<CidadeC>sample string 20</CidadeC>
<CidadeE>sample string 34</CidadeE>
<CidadeF>sample string 6</CidadeF>
<CidadeR>sample string 48</CidadeR>
<CidadeT>sample string 62</CidadeT>
<CodigoIBGECidadeC>sample string 19</CodigoIBGECidadeC>
<CodigoIBGECidadeE>sample string 33</CodigoIBGECidadeE>
<CodigoIBGECidadeF>sample string 5</CodigoIBGECidadeF>
<CodigoIBGECidadeR>sample string 47</CodigoIBGECidadeR>
<CodigoIBGECidadeT>sample string 61</CodigoIBGECidadeT>
<ConteudoEnderecoC>sample string 17</ConteudoEnderecoC>
<ConteudoEnderecoE>sample string 31</ConteudoEnderecoE>
<ConteudoEnderecoF>sample string 3</ConteudoEnderecoF>
<ConteudoEnderecoR>sample string 45</ConteudoEnderecoR>
<ConteudoEnderecoT>sample string 59</ConteudoEnderecoT>
<EmailC>sample string 23</EmailC>
<EmailE>sample string 37</EmailE>
<EmailF>sample string 9</EmailF>
<EmailR>sample string 51</EmailR>
<EmailT>sample string 65</EmailT>
<FaxC>samplestring22</FaxC>
<FaxE>samplestring36</FaxE>
<FaxF>samplestring8</FaxF>
<FaxR>samplestring50</FaxR>
<FaxT>samplestring64</FaxT>
<IdDoPaisC>sample string 15</IdDoPaisC>
<IdDoPaisE>sample string 29</IdDoPaisE>
<IdDoPaisF>sample string 1</IdDoPaisF>
<IdDoPaisR>sample string 43</IdDoPaisR>
<IdDoPaisT>sample string 57</IdDoPaisT>
<LatitudeC>sample string 27</LatitudeC>
<LatitudeE>sample string 41</LatitudeE>
<LatitudeF>sample string 13</LatitudeF>
<LatitudeR>sample string 55</LatitudeR>
<LatitudeT>sample string 69</LatitudeT>
<LongitudeC>sample string 28</LongitudeC>
<LongitudeE>sample string 42</LongitudeE>
<LongitudeF>sample string 14</LongitudeF>
<LongitudeR>sample string 56</LongitudeR>
<LongitudeT>sample string 70</LongitudeT>
<NumeroC>sample string 26</NumeroC>
<NumeroE>sample string 40</NumeroE>
<NumeroF>sample string 11</NumeroF>
<NumeroR>sample string 54</NumeroR>
<NumeroT>sample string 68</NumeroT>
<ObservacaoC>sample string 25</ObservacaoC>
<ObservacaoE>sample string 39</ObservacaoE>
<ObservacaoF>sample string 12</ObservacaoF>
<ObservacaoR>sample string 53</ObservacaoR>
<ObservacaoT>sample string 67</ObservacaoT>
<TelefoneC>samplestring21</TelefoneC>
<TelefoneE>samplestring35</TelefoneE>
<TelefoneF>samplestring7</TelefoneF>
<TelefoneR>samplestring49</TelefoneR>
<TelefoneT>samplestring63</TelefoneT>
<UFC>sample string 16</UFC>
<UFE>sample string 30</UFE>
<UFF>sample string 2</UFF>
<UFR>sample string 44</UFR>
<UFT>sample string 58</UFT>
</Enderecos>
<Financeiro>
<CodigoDaCarteira>1</CodigoDaCarteira>
<CodigoDaListaDePreco>1</CodigoDaListaDePreco>
<CodigoDaMoeda>1</CodigoDaMoeda>
<CodigoDeRisco>1</CodigoDeRisco>
<CodigoDoTransportador1>1</CodigoDoTransportador1>
<CodigoDoTransportador2>1</CodigoDoTransportador2>
<CodigoDoVendedor>1</CodigoDoVendedor>
<CodigoFormaDeCobranca>1</CodigoFormaDeCobranca>
<ConsumidorFinal>sample string 1</ConsumidorFinal>
<DataDaUltimaCompra>2026-04-05T10:29:32.9654109-03:00</DataDaUltimaCompra>
<DataRenovacaoDoCredito>2026-04-05T10:29:32.9654109-03:00</DataRenovacaoDoCredito>
<GrupoEmpresarial>1</GrupoEmpresarial>
<MediaDeAtrasoNoPagamento>1</MediaDeAtrasoNoPagamento>
<PercentualDeDesconto>1</PercentualDeDesconto>
<PercentualDeSubstituicaoTributaria>1</PercentualDeSubstituicaoTributaria>
<PrazoMaximoDeAtraso>1</PrazoMaximoDeAtraso>
<PrazoMedioDeCompra>1</PrazoMedioDeCompra>
<PrazoMedioMaximo>1</PrazoMedioMaximo>
<SubstitutoTributario>sample string 2</SubstitutoTributario>
<ValorDaMaiorCompra>1</ValorDaMaiorCompra>
<ValorDaUltimaCompra>1</ValorDaUltimaCompra>
<ValorDoLimiteDeCredito>1</ValorDoLimiteDeCredito>
<ValorMedioDeCompra>1</ValorMedioDeCompra>
</Financeiro>
<ID>1</ID>
<IDDaFilial>sample string 3</IDDaFilial>
<IDLocalEstoque>sample string 22</IDLocalEstoque>
<IdDaCondicaoDePagamento>sample string 23</IdDaCondicaoDePagamento>
<IdTipoMovimentoFaturamentoEntrada>sample string 33</IdTipoMovimentoFaturamentoEntrada>
<IdTipoMovimentoFaturamentoSaida>sample string 32</IdTipoMovimentoFaturamentoSaida>
<IdentificadorEstadual>NaoAplicavel</IdentificadorEstadual>
<IndicadorMicroEmpresa>sample string 15</IndicadorMicroEmpresa>
<MercadosHabilitados>sample string 31</MercadosHabilitados>
<NomeFantasia>sample string 6</NomeFantasia>
<Observacao>sample string 10</Observacao>
<ObservacaoCadObs>sample string 24</ObservacaoCadObs>
<OrdemDoPercursoParaEntrega>1</OrdemDoPercursoParaEntrega>
<PercentualDeComissaoDoVendedor>17</PercentualDeComissaoDoVendedor>
<PercentualDescontoMaxDaVenda>20</PercentualDescontoMaxDaVenda>
<PercentualRedutorDeComissao>1</PercentualRedutorDeComissao>
<RGIE>sample string 34</RGIE>
<RazaoSocial>sample string 5</RazaoSocial>
<Rg>sample string 9</Rg>
<Suframa>sample string 16</Suframa>
<TipoDaComissaoDoVendedor>sample string 19</TipoDaComissaoDoVendedor>
<TipoDeCadastro>sample string 2</TipoDeCadastro>
<TipoDePessoa>sample string 7</TipoDePessoa>
<TipoDoVendedor>sample string 18</TipoDoVendedor>
<Uf>sample string 14</Uf>
<UtilizaSequenciaDaAtak>true</UtilizaSequenciaDaAtak>
</DTODeCadastroGeralIntegracaoNovo>
application/x-www-form-urlencoded
Exemplo não disponível.
Response Info
Resource Description
Retorna o DTO de Cadastro Geral
HttpResponseMessage| Nome | Descrição | Tipo | Informações adicionais |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |