Saltar al contenido principal

Clientes

El endpoint PostAddCustomer es responsable del registro de un nuevo cliente en el sistema MIMS. Este registro puede ser visualizado en la pantalla CAD043.

Cómo registrar un cliente​

HTTP POST Request

Tipo de SolicitudURL Ejemplo
POST{{url_base}}/PostAddCustomer
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomer"

Parámetros de Entrada​

ParámetroTipoObligatorioDescripción
CustomerNoString(25)SíCódigo externo del cliente
CustomerAuxiliaryNoString(25)NoCódigo externo auxiliar del cliente
CorporateNameString(40)SíNombre del cliente
BusinessNameString(40)SíNombre comercial
ShortNameString(15)NoNombre reducido
GroupNoString(25)NoCódigo externo del grupo del cliente
PhoneString(15)NoNúmero de teléfono
EmailString(200)NoCorreo electrónico
FoundationDateDataNoFecha de fundación
RegisterDateDataHoraNoFecha de registro
FederalRegisterNoString(14)SíCNPJ (Persona Jurídica) o CPF (Persona Física)
StateRegisterNoString(20)SíInscripción estatal (Persona Jurídica) o RG (Persona Física)
NotesString(2000)NoObservación
ShelflifeMinPercentageFloatNoPorcentaje mínimo utilizado en el cálculo de la fecha límite de validez de los productos para el cliente
ShelflifeMaxPercentageFloatNoPorcentaje máximo utilizado en el cálculo de la fecha límite de validez de los productos para el cliente
LocationAddressAddressInfoSíObjeto que contiene las informaciones de la dirección de localización estándar del cliente
DeliveryAddressAddressInfoSíObjeto que contiene las informaciones de la dirección de entrega estándar del cliente
BillingAddressAddressInfoSíObjeto que contiene las informaciones de la dirección de facturación estándar del cliente
PersonTypePersonTypeSíEnumerador con los posibles valores para el Tipo de Persona: ptCompany (Persona Jurídica) o ptPerson (Persona Física)
IsInactiveCustomerBooleanNoFlag que indica que el cliente está inactivo
HasAdministrativeBlockedBooleanNoFlag que indica que el cliente posee bloqueo administrativo
IsRuralProducerBooleanNoFlag que indica que el cliente es productor rural
RegisterRuralProducerNoString(20)NoNúmero de la Inscripción de Productor Rural del Cliente
SuframaNoString(20)NoCódigo suframa del cliente
SellerNoString(25)NoCódigo externo del vendedor
PriceTableNoString(25)NoCódigo externo de la tabla de precio
PromotionalPriceTableNoString(25)NoCódigo externo de la tabla de precio promocional
PaymentMethodNoString(25)NoCódigo externo de la forma de pago
SubLogisticRegionNoString(25)NoCódigo externo de la sub región logística
OverwriteIfExistsBooleanNoFlag que indica que los datos deben ser sobrescritos si el registro ya existe
Observación
  • La obligatoriedad de los parámetros LocationAddress, DeliveryAddress y BillingAddress está definida por configuración. Por defecto, estos parámetros son obligatorios. Para alterar este comportamiento, consulte al consultor responsable.
  • El valor informado en el parámetro FederalRegisterNo debe respetar el tamaño según el tipo de persona especificado en el parámetro PersonType:
    • 14 caracteres cuando PersonType = ptCompany (corresponde al CNPJ)
    • 11 caracteres cuando PersonType = ptPerson (corresponde al CPF)

Retorno​

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnSíInformaciones estándar de respuesta del WebService en la ejecución del método
CustomerCodeIntegerSíCódigo interno del Cliente generado en el sistema MIMS

Ejemplo de Request​

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomer"' \
--header 'Content-Type: application/json' \
--data-raw '{
     "CustomerNo": "CUST001",
    "CustomerAuxiliaryNo": "",
    "CorporateName": "Empresa Ejemplo Ltda",
    "BusinessName": "Empresa Ejemplo",
    "ShortName": "Ejemplo",
    "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 con operación activa",
    "LocationAddress": {
        "AddressType": "Calle",
        "Address": "Av. Paulista",
        "Number": "1000",
        "District": "Bela Vista",
        "ZIPCode": "01310000",
        "City": "São Paulo",
        "State": "São Paulo",
        "StateInitials": "SP",
        "Country": "Brasil"
    },
    "DeliveryAddress": {
        "AddressType": "Calle",
        "Address": "Av. Paulista",
        "Number": "1000",
        "District": "Bela Vista",
        "ZIPCode": "01310000",
        "City": "São Paulo",
        "State": "São Paulo",
        "StateInitials": "SP",
        "Country": "Brasil"
    },
    "BillingAddress": {
        "AddressType": "Calle",
        "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
}'

Ejemplo de Response​

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

🐞 Posibles Errores​

CódigoMensaje
ACT‑001El parámetro Código Externo del Cliente (CustomerNo) informado ya existe!
ACT‑002Informó que el cliente es un productor rural (IsRuralProducer), pero no informó el número de la inscripción de productor rural (RegisterRuralProducerNo)!
ACT‑003Informó el número de la inscripción de productor rural (RegisterRuralProducerNo), pero el cliente no es productor rural (IsRuralProducer)!