API Reference

Crear tercero

Objeto para crear el proveedor

PN: Persona Natural
PJ: Persona Jurídica

{
    "name": "Luis H",
    "lastName": "hernandez",
    "document": "114652258",
    "typeDocumentId": 1,
    "emailNotification": "[email protected]",
    "indicativeContact": "+57",
    "phoneContact": "3000000258",
    "categoryId": 3,
    "dateOfBirth": "1995-12-10",
    "addressData": {
        "street": "calle 35 cr3aw #34-64",
        "city": "Monteria",
        "region": "CO-COR",
        "postalCode": "23001",
        "country": "CO"
    }
}

Explicación de cada objeto

PARÁMETRODESCRIPCIÓNPNPJ
nameNombre de pila de la persona.X
lastNameApellido de la persona.X
tradeNamesolo cuando el tipo de documento es 3(NIT)
Nombre bajo el que se desarrolla la actividad comercial. En este caso, podría ser el nombre de un negocio o emprendimiento.
X
legalNamesolo cuando el tipo de documento es 3(NIT)
Nombre oficial registrado ante las autoridades. En este caso, podría ser la razón social de una empresa.
X
documentNúmero de documento del tercero.XX
typeDocumentIdID del tipo de documento.XX
dvDígito de verificación del documento (solo si aplica).X
emailNotificationDirección de correo electrónico para notificaciones.XX
indicativeContactIndicativo de país para el número de teléfono de contacto.XX
phoneContactNúmero de teléfono de contacto del tercero.XX
categoryIdID de la categoría del tercero.XX
dateOfBirthFecha de nacimiento del usuario en formato YYYY-MM-DD. Ejemplo: "1995-12-10". Este campo es obligatorio en entornos productivos.XX
addressDataInformación completa de la dirección del usuario. Incluye calle, ciudad, región, código postal y país.
Este campo es obligatorio en entornos productivos.
addressData.streetDirección o calle principal del domicilio. Ejemplo: "calle 35 cr3aw #34-64".
addressData.cityCiudad donde reside el usuario. Ejemplo: "Bogotá".
addressData.regionCódigo de región o departamento siguiendo el estándar ISO 3166-2. Ejemplo: "CO-COR" (Córdoba, Colombia).
addressData.postalCodeCódigo postal asociado a la dirección. Ejemplo: "23001".
addressData.countryCódigo de país en formato ISO 3166-1 alfa-2. Ejemplo: "CO" (Colombia).

Campos de respuesta


CampoDescripción
errorIndica si hubo un error. 0 significa que no hubo error.
messageMensaje descriptivo del resultado de la operación.
dataContiene la información del registro guardado.
data.uuidUUID del tercero.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!