Eventos Colombia
Informar eventos mercantiles
Por medio de este método, se puede informar cada uno de los estados mercantiles o estados RADIAN de un documento (Acuse, Recibo, Reclamo, Aceptación, etc).
Para realizar la petición en la API, deberá ingresar los siguientes parámetros:
| Parámetro | Tipo | Descripción | Valores permitidos |
|---|---|---|---|
| ChangeDocumentStatus (request) | |||
| globalDocumentId* | String | Identificación de documento en Gosocket. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| countryDocumentId | String | Identificador fiscal del documento a nivel país, conocido también como CUFE, CLAVE, UUID, ID | Ver tabla Estructura Country Document ID |
| countryId | String | Código del País de emisión del documento | ar, bo, br, cl, co, cr, ec, gt, mx, pa, pe, py, do, sv, uy |
| status* | Integer | Código del estado mercantil o estado RADIAN a informar. | Ejemplo: 30, 31, 32 |
| description* | String | Descripción del estado a informar. | Ejemplo: Autorizado |
| code* | String | Código del Tipo de documento (factura, nota, etc) | 1, 2, 3, … |
*Requerido
Los eventos mercantiles se identifican de la siguiente forma:
| Código | Evento |
|---|---|
| 030 | Acuse de recibo |
| 031 | Reclamo |
| 032 | Recibo del bien y/o prestación del servicio |
| 033 | Aceptación expresa |
| 034 | Aceptación Tácita |
Los eventos RADIAN se identifican de la siguiente forma:
| Código | Evento |
|---|---|
| 035 | Aval |
| 036 | Inscripción en el RADIAN de la factura electrónica de venta como título valor que circula en el territorio nacional |
| 037 | Endoso en propiedad |
| 038 | Endoso en garantía |
| 039 | Endoso en procuración |
| 040 | Cancelación del Endoso electrónico |
| 041 | Limitación para circulación de la factura electrónica de venta como título valor |
| 042 | Terminación de la limitación para circulación de la factura electrónica de venta como título valor |
| 043 | Mandato |
| 044 | Terminación del mandato |
| 045 | Pago de la factura electrónica de venta como título valor |
| 046 | Informe para el pago |
| 047 | Endoso con efectos de cesión ordinaria |
| 048 | Protesto |
| 049 | Transferencia de los derechos económicos |
| 050 | Notificación al deudor sobre la transferencia de los derechos económicos |
| 051 | Pago de la transferencia de los derechos económicos |
Ejemplo de petición
POST https://developers.gosocket.net/sandbox/api/v1/Document/ChangeDocumentStatus
?globalDocumentId=00000000-0000-0000-0000-000000000000
&countryId=co
&status=30
&description=acuse de recibo factura
&code=1
Datos ficticios
Los identificadores de los ejemplos de esta página son ficticios.
Nota: Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.
Para este método utilizamos la pestaña Params de Postman.
- Seleccione el tipo de método. En este caso, se debe seleccionar POST.
- Ingrese la URL del método.
- Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
- Presione Send.
Ejemplo de respuesta
{
"Success": true,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"OtherData": {
"Country": "co",
"Certifier": "DIAN",
"AuthorityTimeStamp": "06/09/2023 16:38:47"
},
"Messages": [
"Regla: 0, Notificación: La Application response 0000000000, ha sido autorizada."
],
"ResponseValue": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZ...",
"Code": "00",
"Description": "La Application response 0000000000, ha sido autorizada.",
"ErrorException": null
}Nota: el valor de ResponseValue se muestra truncado; corresponde a la respuesta de la entidad codificada en base 64.
Para interpretar correctamente la respuesta de la API, tome en cuenta los siguientes criterios:
| Parámetro | Tipo | Descripción | Valores permitidos |
|---|---|---|---|
| ChangeDocumentStatus (response) | |||
| Success | Boolean | Indica si la petición se ejecutó correctamente. | true: La petición se ejecutó correctamente. false: La petición se ejecutó con alguna inconsistencia. |
| GlobalDocumentId | String | Identificación de documento en Gosocket. | 00000000-0000-0000-0000-000000000000 |
| CountryDocumentId | String | Identificador fiscal del documento a nivel país, conocido también como CUFE, CLAVE, UUID, ID | Ver tabla Estructura Country Document ID |
| OtherData | String | Propiedades adicionales de acuerdo con el país. | Ejemplo Chile: {"Folio": "17529"} |
| Messages | String | Reglas validadas para el documento de acuerdo con el código mercantil o código RADIAN | Ejemplo Colombia: "Regla: 0, Notificación: La Application response 6473921416, ha sido autorizada." |
| ResponseValue | String | Respuesta de la entidad codificada en base 64. | |
| Code | String | Código de respuesta del proceso | Ejemplos: 500: Se presentó alguna inconsistencia 0 o 00: Funcionó correctamente 99: alguna regla no pasó la validación 400: Documento no encontrado |
| Description | String | Descripción de la respuesta del proceso realizado | Ejemplo Chile: "Respuesta del SII para el documento folio 17451: Acción Completada OK." |
| ErrorException | String | Descripción de la excepción cuando se presenta un error. |
Características del método ChangeDocumentStatus
- El método permite informar uno a uno los estados del acuse mercantil o estado de RADIAN.
- Cuando se envía en la petición el parámetro CountryDocumentId y el parámetro countryId no se requiere enviar de forma obligatoria el parámetro GlobalDocumentId
- Cuando no se conoce el valor del CountryDocumentId, se debe enviar el parámetro GlobalDocumentId
- En el parámetro OtherData se pueden encontrar las siguientes propiedades:
{
"Country": "co",
"Certifier": "DIAN",
"AuthorityTimeStamp": "25/07/2022 19:20:31"
}-
Algunos ejemplos de reglas validadas en el proceso del parámetro messages son:
- "Evento no puede ser registrado ya que el documento presenta un evento previo de acuse de recibo de la factura electrónica de venta."
- "La Application response 6473921416, ha sido autorizada."
- "Solo se pueda transmitir el evento (034) Aceptación Tácita de la factura, pasados 3 días hábiles, después de la transmisión del evento (032) recibo del bien o aceptación de la prestación del servicio"
- "No se puede recibir un reclamo si previamente no se han recibido los eventos Acuse de recibo de la factura electrónica y un recibo de bien y prestación de servicio"
- "Esta UUID no existe en la base de datos de la DIAN"
-
Cuando no existe el Id del documento (globalDocumentId), el sistema responde:
{
"Success": false,
"GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
"CountryDocumentId": null,
"OtherData": null,
"Messages": null,
"ResponseValue": null,
"Code": "400",
"Description": "Document Not Found",
"ErrorException": null
}Veámos los diferentes escenarios en los que podemos utilizar este método.