ChangeDocumentStatus

Ejecuta eventos sobre un documento ya enviado: cancelación, carta de corrección, confirmación de operación, entre otros.

Endpoint

QAhttps://developers-sbx.gosocket.net/api/v1/Document/ChangeDocumentStatus

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Document/ChangeDocumentStatus

Método: POST

Parámetros de entrada

AtributoTipoDescripción

globalDocumentIdstringIdentificador global único del documento en la plataforma Gosocket. Requerido.

statusstringCódigo de operación o evento a ejecutar. Ver tabla de valores permitidos abajo. Requerido.

descriptionstringMotivo por el cual se emite la operación o evento. Requerido.

stampNumberstringProtocolo SEFAZ del evento aprobado que se relaciona con la cancelación. Condicional: solo aplica para el evento 110001.

codestringTipo de documento del evento relacionado. Condicional: solo aplica para el evento 110001.

Valores permitidos para status

Código	Descripción	Proceso	NF-e	CT-e	MDF-e	NFS-e
110001	Cancelamento de Evento	📤	✅	❌	❌	❌
110110	Carta de correção	📤	✅	✅	❌	❌
110111	Cancelamento	📤	✅	✅	✅	✅
110112	Encerramento	📤	❌	❌	✅	❌
110114	Inclusao Condutor	📤	❌	❌	✅	❌
112110	Informação de efetivo pagamento para liberar crédito presumido	📤	✅	❌	❌	❌
210200	Confirmação da operação	📥	✅	❌	❌	❌
210210	Ciência da operação	📥	✅	❌	❌	❌
210220	Desconhecimento da operação	📥	✅	❌	❌	❌
210240	Operação não realizada	📥	✅	❌	❌	❌
211128	Aceite de débito na apuração por emissão de nota de crédito	📥	✅	❌	❌	❌
1009	Inutilização	📤	✅	❌	❌	❌

Parámetros de respuesta

AtributoTipoDescripción

Successbooleantrue si la operación fue exitosa; false si ocurrió un error.

GlobalDocumentIdstringIdentificador global único del documento en la plataforma Gosocket.

CountryDocumentIdstringID del documento asignado por la autoridad. Puede ser null en servicios asíncronos.

OtherData.ProtocolNumberstringNúmero de protocolo interno del evento procesado.

OtherData.ProtocolSefazstringNúmero de protocolo asignado por SEFAZ.

OtherData.IssueDatestringFecha y hora de emisión del evento en formato ISO 8601.

OtherData.SeriesNumberstringSerie y correlativo del documento afectado.

OtherData.CountrystringCódigo del país. Ejemplo: "br".

OtherData.CertifierstringCertificador del documento.

OtherData.AuthorityTimeStampstringFecha y hora en que el evento fue registrado por la autoridad.

MessagesarrayLista de mensajes adicionales o errores. Vacía si no hay errores.

ResponseValuestringContenido del evento en formato XML, codificado como string.