Clientes
Descripción
El endpoint PostAddCustomer es responsable del registro de un nuevo cliente en el sistema MIMS y puede ser visualizado en la pantalla CAD043.
Cómo registrar un nuevo cliente
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddCustomer |
| Ejemplo | http://suIPyPuerto/datasnap/rest/RESTWebServiceMethods/"PostAddCustomer" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| CustomerNo | String(25) | Sí | Código Externo del Cliente |
| CustomerAuxiliaryNo | String(25) | No | Código Externo Auxiliar del Cliente |
| CorporateName | String(40) | Sí | Nombre del Cliente |
| BusinessName | String(40) | Sí | Nombre Comercial |
| ShortName | String(15) | No | Nombre Reducido |
| GroupNo | String(25) | No | Código Externo del Grupo del Cliente |
| Phone | String(15) | No | Número de Teléfono |
| String(200) | No | ||
| FoundationDate | Data | No | Fecha de Fundación |
| RegisterDate | DataHora | No | Fecha de Registro del Cliente |
| FederalRegisterNo | String(14) | Sí | CNPJ / CPF |
| StateRegisterNo | String(20) | Sí | Inscripción Estadual / RG |
| Notes | String(2000) | No | Observación |
| ShelflifeMinPercentage | Float | No | Porcentaje mínimo utilizado en el cálculo de la fecha límite de validez de los productos para el cliente |
| ShelflifeMaxPercentage | Float | No | Porcentaje máximo utilizado en el cálculo de la fecha límite de validez de los productos para el cliente |
| LocationAddress | AddressInfo | Sí | Objeto que contiene la información de la dirección de ubicación predeterminada del cliente |
| DeliveryAddress | AddressInfo | Sí | Objeto que contiene la información de la dirección de entrega predeterminada del cliente |
| BillingAddress | AddressInfo | Sí | Objeto que contiene la información de la dirección de facturación predeterminada del cliente |
| PersonType | PersonType | Sí | Enumerador con los posibles valores para el Tipo de Persona: ptCompany (Persona Jurídica), ptPerson (Persona Física) |
| IsInactiveCustomer | Boolean | No | Bandera que indica que el cliente está inactivo |
| HasAdministrativeBlocked | Boolean | No | Bandera que indica que el cliente posee bloqueo administrativo |
| IsRuralProducer | Boolean | No | Bandera que indica que el cliente es productor rural |
| RegisterRuralProducerNo | String(20) | No | Número de la Inscripción de Productor Rural del Cliente |
| SuframaNo | String(20) | No | Código Suframa del Cliente |
| SellerNo | String(25) | No | Código Externo del Vendedor |
| PriceTableNo | String(25) | No | Código Externo de la Tabla de Precio |
| PromotionalPriceTableNo | String(25) | No | Código Externo de la Tabla de Precio Promocional |
| PaymentMethodNo | String(25) | No | Código Externo de la Forma de Pago |
| SubLogisticRegionNo | String(25) | No | Código Externo de la Sub Región Logística |
| OverwriteIfExists | Boolean | No | Bandera que indica que los datos deben ser sobrescritos caso el registro ya exista |
Observação
- La obligatoriedad de los parámetros
LocationAddress,DeliveryAddressyBillingAddressse define por configuración. Por defecto, estos parámetros son obligatorios. Para cambiar este comportamiento, consulte al consultor responsable.
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Información estándar de respuesta del Webservice en la ejecución del método |
| CustomerCode | Integer | Sí | Código interno del Cliente generado en el sistema MIMS |
Ejemplo de Request
curl --location --request POST '{{url_base}}/PostAddCustomer' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"CustomerNo": "CUST001",
"CustomerAuxiliaryNo": "",
"CorporateName": "Empresa Ejemplo Ltda",
"BusinessName": "Empresa Ejemplo",
"ShortName": "Ejemplo",
"GroupNo": "G001",
"Phone": "11999999999",
"Email": "contacto@ejemplo.com",
"FoundationDate": "2000-01-01",
"RegisterDate": "2024-02-06T12:00:00",
"FederalRegisterNo": "12345678000195",
"StateRegisterNo": "EXENTO",
"RegisterRuralProducerNo": "",
"SuframaNo": "",
"Notes": "Cliente VIP",
"ShelflifeMinPercentage": 30.0,
"ShelflifeMaxPercentage": 90.0,
"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": false,
"RegisterRuralProducerNo": "",
"SuframaNo": "",
"SellerNo": "S001",
"PriceTableNo": "TBL001",
"PromotionalPriceTableNo": "TBL002",
"PaymentMethodNo": "PM001",
"SubLogisticRegionNo": "SLR001",
"OverwriteIfExists": true
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"CustomerCode": 12345
}