POST api/Cliente?chave={chave}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| chave | globally unique identifier |
Required |
Body Parameters
ClienteModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Codigo | integer |
None. |
|
| NomeFantasia | string |
None. |
|
| RazaoSocial | string |
None. |
|
| Endereco | EnderecoModel |
None. |
|
| Telefone | Collection of TelefoneModel |
None. |
|
| string |
None. |
||
| EmailFinanceiro | string |
None. |
|
| PaginaWeb | string |
None. |
|
| Cnpj | string |
None. |
|
| InscricaoEstadual | string |
None. |
|
| TransportadorId | globally unique identifier |
None. |
|
| TipoFrete | TipoFreteNModel |
None. |
|
| Contato | string |
None. |
|
| Observacoes | string |
None. |
|
| CodigoERP | string |
None. |
|
| Ativo | boolean |
None. |
|
| EmpresaId | globally unique identifier |
None. |
|
| ValorLimiteCredito | decimal number |
None. |
|
| ValorMinimoVendas | decimal number |
None. |
|
| ValorMaximoAtraso | decimal number |
None. |
|
| UsuarioRepresentanteId | globally unique identifier |
None. |
|
| TransportadorRedespacho | TransportadorRedespachoModel |
None. |
|
| CondicaoPagamentoId | globally unique identifier |
None. |
|
| CalculaIcmsSt | boolean |
None. |
|
| NaoCalculaIcms | boolean |
None. |
|
| NaoCalculaIpi | boolean |
None. |
|
| ImpostosSimples | boolean |
None. |
|
| DataAtualizacao | date |
None. |
|
| CamposAdicionais | Collection of CampoAdicionalValorModel |
None. |
|
| BloquearUso | boolean |
None. |
|
| ValorTitulosPendentes | decimal number |
None. |
|
| ValorTitulosAtrasados | decimal number |
None. |
|
| PercentualDesconto | decimal number |
None. |
|
| FretePadrao | decimal number |
None. |
|
| IndicadorIE | integer |
None. |
|
| DivisaoId | globally unique identifier |
None. |
|
| ListaPrecoId | globally unique identifier |
None. |
|
| PermitirUsarCondicaoPagamento | integer |
None. |
|
| PermitirAcessoB2B | integer |
None. |
|
| UtilizacaoPrincipal | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "ebd23502-2a9a-419c-a7a1-f871cf14bcc2",
"Codigo": 2,
"NomeFantasia": "sample string 3",
"RazaoSocial": "sample string 4",
"Endereco": {
"Id": "c2aa5486-b31c-4e34-b733-3bb3d06a40f0",
"Rua": "sample string 2",
"Bairro": "sample string 3",
"CEP": 4,
"CidadeId": "d0bc79b9-08df-4cbb-9a70-1e8c6e3a1fae",
"EnderecoNumero": 6,
"EnderecoComplemento": "sample string 7",
"EnderecoLatitude": 8.0,
"EnderecoLongitude": 9.0,
"DataAtualizacao": "2025-12-06T02:42:47.7432515-03:00"
},
"Telefone": [
{
"Id": "66dd9b23-9bc6-45ac-9f9a-e56c8298445a",
"Ramal": 2,
"Numero": "sample string 3",
"Tipo": 0
},
{
"Id": "66dd9b23-9bc6-45ac-9f9a-e56c8298445a",
"Ramal": 2,
"Numero": "sample string 3",
"Tipo": 0
}
],
"Email": "sample string 5",
"EmailFinanceiro": "sample string 6",
"PaginaWeb": "sample string 7",
"Cnpj": "sample string 8",
"InscricaoEstadual": "sample string 9",
"TransportadorId": "7b9ff229-4aa7-440a-aadf-911843c054bf",
"TipoFrete": 0,
"Contato": "sample string 11",
"Observacoes": "sample string 12",
"CodigoERP": "sample string 13",
"Ativo": true,
"EmpresaId": "540ab5f0-e086-437f-b65a-66a804d12c45",
"ValorLimiteCredito": 16.0,
"ValorMinimoVendas": 17.0,
"ValorMaximoAtraso": 18.0,
"UsuarioRepresentanteId": "c9addac3-ac76-4c3e-84cf-d91756f1fe29",
"TransportadorRedespacho": {
"Nome": "sample string 1",
"TelefoneRedespacho": {
"Id": "66dd9b23-9bc6-45ac-9f9a-e56c8298445a",
"Ramal": 2,
"Numero": "sample string 3",
"Tipo": 0
}
},
"CondicaoPagamentoId": "b4973208-7c83-457c-8694-a4db228217b2",
"CalculaIcmsSt": true,
"NaoCalculaIcms": true,
"NaoCalculaIpi": true,
"ImpostosSimples": true,
"DataAtualizacao": "2025-12-06T02:42:47.7432515-03:00",
"CamposAdicionais": [
{
"Campo": {
"Id": "5d911c19-047d-4af6-b576-38761fb36712",
"Nome": "sample string 2",
"TipoDado": null,
"Tamanho": 3,
"Descricao": "sample string 4",
"ValoresPossiveis": [
"sample string 1",
"sample string 2"
]
},
"Id": "69c193c7-4b8e-46e1-b857-123f5a34a4f4",
"Valor": {}
},
{
"Campo": {
"Id": "5d911c19-047d-4af6-b576-38761fb36712",
"Nome": "sample string 2",
"TipoDado": null,
"Tamanho": 3,
"Descricao": "sample string 4",
"ValoresPossiveis": [
"sample string 1",
"sample string 2"
]
},
"Id": "69c193c7-4b8e-46e1-b857-123f5a34a4f4",
"Valor": {}
}
],
"BloquearUso": true,
"ValorTitulosPendentes": 27.0,
"ValorTitulosAtrasados": 28.0,
"PercentualDesconto": 29.0,
"FretePadrao": 30.0,
"IndicadorIE": 31,
"DivisaoId": "ecd14c5b-a11a-4ec8-87c7-332dad7a3d64",
"ListaPrecoId": "83815815-03e4-470f-88be-80320bba1824",
"PermitirUsarCondicaoPagamento": 34,
"PermitirAcessoB2B": 35,
"UtilizacaoPrincipal": 36
}
application/xml, text/xml
Sample:
<ClienteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Softbyte.PedidosWeb.ApiAspNet.Models">
<Ativo>true</Ativo>
<BloquearUso>true</BloquearUso>
<CalculaIcmsSt>true</CalculaIcmsSt>
<CamposAdicionais>
<CampoAdicionalValorModel>
<Campo>
<Descricao>sample string 4</Descricao>
<Id>5d911c19-047d-4af6-b576-38761fb36712</Id>
<Nome>sample string 2</Nome>
<Tamanho>3</Tamanho>
<TipoDado xmlns:d5p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
<ValoresPossiveis xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</ValoresPossiveis>
</Campo>
<Id>69c193c7-4b8e-46e1-b857-123f5a34a4f4</Id>
<Valor />
</CampoAdicionalValorModel>
<CampoAdicionalValorModel>
<Campo>
<Descricao>sample string 4</Descricao>
<Id>5d911c19-047d-4af6-b576-38761fb36712</Id>
<Nome>sample string 2</Nome>
<Tamanho>3</Tamanho>
<TipoDado xmlns:d5p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
<ValoresPossiveis xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</ValoresPossiveis>
</Campo>
<Id>69c193c7-4b8e-46e1-b857-123f5a34a4f4</Id>
<Valor />
</CampoAdicionalValorModel>
</CamposAdicionais>
<Cnpj>sample string 8</Cnpj>
<Codigo>2</Codigo>
<CodigoERP>sample string 13</CodigoERP>
<CondicaoPagamentoId>b4973208-7c83-457c-8694-a4db228217b2</CondicaoPagamentoId>
<Contato>sample string 11</Contato>
<DataAtualizacao>2025-12-06T02:42:47.7432515-03:00</DataAtualizacao>
<DivisaoId>ecd14c5b-a11a-4ec8-87c7-332dad7a3d64</DivisaoId>
<Email>sample string 5</Email>
<EmailFinanceiro>sample string 6</EmailFinanceiro>
<EmpresaId>540ab5f0-e086-437f-b65a-66a804d12c45</EmpresaId>
<Endereco>
<Bairro>sample string 3</Bairro>
<CEP>4</CEP>
<CidadeId>d0bc79b9-08df-4cbb-9a70-1e8c6e3a1fae</CidadeId>
<DataAtualizacao>2025-12-06T02:42:47.7432515-03:00</DataAtualizacao>
<EnderecoComplemento>sample string 7</EnderecoComplemento>
<EnderecoLatitude>8</EnderecoLatitude>
<EnderecoLongitude>9</EnderecoLongitude>
<EnderecoNumero>6</EnderecoNumero>
<Id>c2aa5486-b31c-4e34-b733-3bb3d06a40f0</Id>
<Rua>sample string 2</Rua>
</Endereco>
<FretePadrao>30</FretePadrao>
<Id>ebd23502-2a9a-419c-a7a1-f871cf14bcc2</Id>
<ImpostosSimples>true</ImpostosSimples>
<IndicadorIE>31</IndicadorIE>
<InscricaoEstadual>sample string 9</InscricaoEstadual>
<ListaPrecoId>83815815-03e4-470f-88be-80320bba1824</ListaPrecoId>
<NaoCalculaIcms>true</NaoCalculaIcms>
<NaoCalculaIpi>true</NaoCalculaIpi>
<NomeFantasia>sample string 3</NomeFantasia>
<Observacoes>sample string 12</Observacoes>
<PaginaWeb>sample string 7</PaginaWeb>
<PercentualDesconto>29</PercentualDesconto>
<PermitirAcessoB2B>35</PermitirAcessoB2B>
<PermitirUsarCondicaoPagamento>34</PermitirUsarCondicaoPagamento>
<RazaoSocial>sample string 4</RazaoSocial>
<Telefone>
<TelefoneModel>
<Id>66dd9b23-9bc6-45ac-9f9a-e56c8298445a</Id>
<Numero>sample string 3</Numero>
<Ramal>2</Ramal>
<Tipo>Residencial</Tipo>
</TelefoneModel>
<TelefoneModel>
<Id>66dd9b23-9bc6-45ac-9f9a-e56c8298445a</Id>
<Numero>sample string 3</Numero>
<Ramal>2</Ramal>
<Tipo>Residencial</Tipo>
</TelefoneModel>
</Telefone>
<TipoFrete>FOB</TipoFrete>
<TransportadorId>7b9ff229-4aa7-440a-aadf-911843c054bf</TransportadorId>
<TransportadorRedespacho>
<Nome>sample string 1</Nome>
<TelefoneRedespacho>
<Id>66dd9b23-9bc6-45ac-9f9a-e56c8298445a</Id>
<Numero>sample string 3</Numero>
<Ramal>2</Ramal>
<Tipo>Residencial</Tipo>
</TelefoneRedespacho>
</TransportadorRedespacho>
<UsuarioRepresentanteId>c9addac3-ac76-4c3e-84cf-d91756f1fe29</UsuarioRepresentanteId>
<UtilizacaoPrincipal>36</UtilizacaoPrincipal>
<ValorLimiteCredito>16</ValorLimiteCredito>
<ValorMaximoAtraso>18</ValorMaximoAtraso>
<ValorMinimoVendas>17</ValorMinimoVendas>
<ValorTitulosAtrasados>28</ValorTitulosAtrasados>
<ValorTitulosPendentes>27</ValorTitulosPendentes>
</ClienteModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |