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 como querystring

Los parámetros se envían en la URL como querystring, no en el body. El body de la petición va vacío.

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.

accountCodestringCNPJ de la cuenta acreedora. Condicional: requerido para los eventos 110001, 112110 y 211128.

stampNumberstringProtocolo SEFAZ del evento relacionado con la cancelación. Condicional: solo aplica para el evento 110001.

codestringCódigo del tipo de 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 — la operación fue exitosa.

GlobalDocumentIdstringIdentificador global único del documento en la plataforma Gosocket.

CountryDocumentIdstringChave de acesso del documento (44 dígitos).

OtherData.ProtocolNumberstringGUID del protocolo interno del evento procesado por NDD. Ejemplo: "966244f4-fa50-4987-902c-f6432c9461f1".

OtherData.ProtocolSefazstringNúmero de protocolo asignado por SEFAZ.

OtherData.IssueDatestringFecha y hora del evento en formato ISO 8601 con timezone. Ejemplo: "2026-06-02T18:47:36-03:00".

OtherData.SeriesNumberstringNúmero de serie del documento afectado.

OtherData.DatastringRespuesta interna de NDD codificada en Base64. Contiene el XML del evento y datos de trazabilidad.

OtherData.CountrystringCódigo del país. Siempre "br".

OtherData.CertifierstringCertificador. Siempre "NDD" para esta integración.

OtherData.AuthorityTimeStampstringFecha y hora en que el evento fue registrado. Formato: "dd/MM/yyyy HH:mm:ss".

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

ResponseValuestringXML del evento procesado codificado en Base64.

CodestringCódigo cStat de SEFAZ propagado por NDD. Es el código de respuesta del **evento**, no de la autorización del documento. Ejemplos: "135" (evento registrado y vinculado al documento), "136" (evento registrado pero no vinculado — típico de EPEC cuando el documento aún no existe en SEFAZ).

DescriptionstringDescripción del resultado emitida por NDD. Ejemplo: "Evento registrado com sucesso, Cancelamento".

ErrorExceptionobjectnull si no hay error.

Ejemplos

ChangeDocumentStatus — Request

POST /api/v1/Document/ChangeDocumentStatus
?GlobalDocumentId=7b28000c-ae96-f63e-5639-fffdf28c7fd9
&status=110111
&description=Cancelamento+por+erro+no+valor+do+imposto

ChangeDocumentStatus — Response

{
"Success": true,
"GlobalDocumentId": "7b28000c-ae96-f63e-5639-fffdf28c7fd9",
"CountryDocumentId": "33260600000000000100550010000000010000000000",
"OtherData": {
  "ProtocolNumber": "966244f4-fa50-4987-902c-f6432c9461f1",
  "ProtocolSefaz": "333260000242212",
  "IssueDate": "2026-06-02T18:47:36-03:00",
  "SeriesNumber": "12010",
  "Data": "eyJ0aXBvUmV0b3JubyI6MiwiZXZlbnRvIjp7...",
  "Country": "br",
  "Certifier": "NDD",
  "AuthorityTimeStamp": "02/06/2026 18:47:28"
},
"Messages": [],
"ResponseValue": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48...",
"Code": "135",
"Description": "Evento registrado com sucesso, Cancelamento",
"ErrorException": null
}

Notas

Autenticación

Todos los métodos requieren autenticación Basic Auth. Usa el API Key como usuario y el API Secret como contraseña. Ambas credenciales se generan en el portal de Gosocket.

Operaciones de recepción (AP)

Los eventos 210200, 210210, 210220 y 210240 corresponden a confirmación de operación del receptor y solo aplican a NF-e. Para los demás tipos de documento, usa únicamente los eventos listados como compatibles en la tabla.

Parámetros condicionales

• accountCode es obligatorio para los eventos 110001, 112110 y 211128. Contiene el CNPJ de la cuenta acreedora involucrada en la operación.
• stampNumber y code son obligatorios únicamente para el evento 110001 (Cancelamento de Evento). Enviarlos en otros eventos puede causar rechazo por parte de SEFAZ.