Clientes

O endpoint PostAddCustomer é responsável pelo cadastro de um novo cliente no sistema MIMS. Esse cadastro pode ser visualizado na tela CAD043.

---

Como cadastrar um cliente

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddCustomer
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomer"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
CustomerNo	String(25)	Sim	Código externo do cliente
CustomerAuxiliaryNo	String(25)	Não	Código externo auxiliar do cliente
CorporateName	String(40)	Sim	Nome do cliente
BusinessName	String(40)	Sim	Nome fantasia
ShortName	String(15)	Não	Nome reduzido
GroupNo	String(25)	Não	Código externo do grupo do cliente
Phone	String(15)	Não	Número de telefone
Email	String(200)	Não	E-mail
FoundationDate	Data	Não	Data de fundação
RegisterDate	DataHora	Não	Data de cadastro
FederalRegisterNo	String(14)	Sim	CNPJ (Pessoa Jurídica) ou CPF (Pessoa Física)
StateRegisterNo	String(20)	Sim	Inscrição estadual (Pessoa Jurídica) ou RG (Pessoa Física)
Notes	String(2000)	Não	Observação
ShelflifeMinPercentage	Float	Não	Porcentagem mínima utilizada no cálculo da data limite de validade dos produtos para o cliente
ShelflifeMaxPercentage	Float	Não	Porcentagem máxima utilizada no cálculo da data limite de validade dos produtos para o cliente
LocationAddress	AddressInfo	Sim	Objeto que contém as informações do endereço de localização padrão do cliente
DeliveryAddress	AddressInfo	Sim	Objeto que contém as informações do endereço de entrega padrão do cliente
BillingAddress	AddressInfo	Sim	Objeto que contém as informações do endereço de cobrança padrão do cliente
PersonType	PersonType	Sim	Enumerador com os possíveis valores para o Tipo de Pessoa: ptCompany (Pessoa Jurídica) ou ptPerson (Pessoa Física)
IsInactiveCustomer	Boolean	Não	Flag que indica que o cliente está inativo
HasAdministrativeBlocked	Boolean	Não	Flag que indica que o cliente possui bloqueio administrativo
IsRuralProducer	Boolean	Não	Flag que indica que o cliente é produtor rural
RegisterRuralProducerNo	String(20)	Não	Número da Inscrição de Produtor Rural do Cliente
SuframaNo	String(20)	Não	Código suframa do cliente
SellerNo	String(25)	Não	Código externo do vendedor
PriceTableNo	String(25)	Não	Código externo da tabela de preço
PromotionalPriceTableNo	String(25)	Não	Código externo da tabela de preço promocional
PaymentMethodNo	String(25)	Não	Código externo da forma de pagamento
SubLogisticRegionNo	String(25)	Não	Código externo da sub região logística
OverwriteIfExists	Boolean	Não	Flag que indica que os dados devem ser sobrescritos caso o registro já exista

Observação

• A obrigatoriedade dos parâmetros LocationAddress, DeliveryAddress e BillingAddress é definida por configuração. Por padrão, esses parâmetros são obrigatórios. Para alterar esse comportamento, consulte o consultor responsável.
• O valor informado no parâmetro FederalRegisterNo deve respeitar o tamanho conforme o tipo de pessoa especificado no parâmetro PersonType:
  • 14 caracteres quando PersonType = ptCompany (corresponde ao CNPJ)
  • 11 caracteres quando PersonType = ptPerson (corresponde ao CPF)

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
CustomerCode	Integer	Sim	Código interno do Cliente gerado no sistema MIMS

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomer"' \
--header 'Content-Type: application/json' \
--data-raw '{
     "CustomerNo": "CUST001",
    "CustomerAuxiliaryNo": "",
    "CorporateName": "Empresa Exemplo Ltda",
    "BusinessName": "Empresa Exemplo",
    "ShortName": "Exemplo",
    "GroupNo": "G001",
    "Phone": "11999999999",
    "Email": "contato@exemplo.com",
    "FoundationDate": "2000-01-01",
    "RegisterDate": "2024-02-06T12:00:00",
    "FederalRegisterNo": "12345678000195",
    "StateRegisterNo": "ISENTO",
    "ShelflifeMinPercentage": 15.0,
    "ShelflifeMaxPercentage": 60.0,
    "Notes": "Cliente com operação ativa",
    "LocationAddress": {
        "AddressType": "Rua",
        "Address": "Av. Paulista",
        "Number": "1000",
        "District": "Bela Vista",
        "ZIPCode": "01310000",
        "City": "São Paulo",
        "State": "São Paulo",
        "StateInitials": "SP",
        "Country": "Brasil"
    },
    "DeliveryAddress": {
        "AddressType": "Rua",
        "Address": "Av. Paulista",
        "Number": "1000",
        "District": "Bela Vista",
        "ZIPCode": "01310000",
        "City": "São Paulo",
        "State": "São Paulo",
        "StateInitials": "SP",
        "Country": "Brasil"
    },
    "BillingAddress": {
        "AddressType": "Rua",
        "Address": "Av. Paulista",
        "Number": "1000",
        "District": "Bela Vista",
        "ZIPCode": "01310000",
        "City": "São Paulo",
        "State": "São Paulo",
        "StateInitials": "SP",
        "Country": "Brasil"
    },
    "PersonType": "ptCompany",
    "IsInactiveCustomer": false,
    "HasAdministrativeBlocked": false,
    "IsRuralProducer": true,
    "RegisterRuralProducerNo": "PR-2025-0098",
    "SuframaNo": "SUF-456789",
    "SellerNo": "VEND-015",
    "PriceTableNo": "TAB-PRC-01",
    "PromotionalPriceTableNo": "TAB-PROMO-02",
    "PaymentMethodNo": "PM001",
    "SubLogisticRegionNo": "SLR001",
    "OverwriteIfExists": true
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "CustomerCode": 12345
}

---

🐞 Possíveis Erros

Código	Mensagem
ACT‑001	Parâmetro Código Externo do Cliente (CustomerNo) informado já existe!
ACT‑002	Informou que o cliente é um produtor rural (IsRuralProducer), mas não informou o número da inscrição de produtor rural (RegisterRuralProducerNo)!
ACT‑003	Informou o número da inscrição de produtor rural (RegisterRuralProducerNo), mas o cliente não é produtor rural (IsRuralProducer)!

---