ChangeDocumentStatus
Ejecuta eventos sobre un documento ya enviado: cancelación, carta de corrección, confirmación de operación, entre otros.
Endpoint
Disponible en ambas versiones de la API — ver Autenticación para elegir cuál te corresponde.
Basic Auth — v1
QA
https://developers-sbx.gosocket.net/api/v1/Document/ChangeDocumentStatusPRODUCCIÓN
https://developers.gosocket.net/api/v1/Document/ChangeDocumentStatusOAuth 2.0 — v2
QA
https://developers-sbx.gosocket.net/api/v2/Document/ChangeDocumentStatusPRODUCCIÓN
https://developers.gosocket.net/api/v2/Document/ChangeDocumentStatusMé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.
Excepción — eventos de Reforma Tributária con
itemsDataLos eventos 112130, 112140 y 211130 (ver tabla abajo) requieren enviar un arreglo de ítems (itemsData) que no se puede expresar como querystring plano. Para estos tres eventos, todos los parámetros —incluidos GlobalDocumentId, status y description— se envían en el body como application/x-www-form-urlencoded, no en la URL. El evento 112150 sí sigue el patrón estándar de querystring (no usa itemsData).
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.
dPrevEntregastringNueva fecha de previsão de entrega, formato "yyyy-MM-dd". Se mapea a <dPrevEntrega> en el XML del evento. Condicional: requerido únicamente para el evento 112150.
itemsData[n].quantitystringCantidad del ítem afectado por el evento (arreglo indexado desde 0). Se mapea a qImobilizado / qPerecimento / qNaoFornecida dentro de gControleEstoque, según el evento. Condicional: requerido para los eventos 112130, 112140 y 211130.
itemsData[n].unitstringUnidad de medida del ítem (ej. "UN"). Se mapea a uImobilizado / uPerecimento / uNaoFornecida dentro de gControleEstoque. Condicional: requerido para los eventos 112130, 112140 y 211130.
itemsData[n].ibsValuestringValor de IBS (Imposto sobre Bens e Serviços) del ítem, de la Reforma Tributária. Se mapea a <vIBS>. Condicional: requerido para los eventos 112130, 112140 y 211130.
itemsData[n].cbsValuestringValor de CBS (Contribuição sobre Bens e Serviços) del ítem, de la Reforma Tributária. Se mapea a <vCBS>. Condicional: requerido para los eventos 112130, 112140 y 211130.
itemsData[n].gibsValue / itemsData[n].gcbsValuestringValor de estorno de crédito de IBS/CBS referente às aquisições (grupo gControleEstoque, P31/P32), específico del evento 112130.
Valores permitidos para status
| Código | Descripción | Proceso | NF-e | CT-e | MDF-e | NFS-e | Estado |
|---|---|---|---|---|---|---|---|
1009 | Inutilização | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
110001 | Cancelamento de Evento | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
110110 | Carta de correção | 📤 | ✅ | ✅ | ❌ | ❌ | ✅ Disponible |
110111 | Cancelamento | 📤 | ✅ | ✅ | ✅ | ✅ | ✅ Disponible |
110112 | Encerramento | 📤 | ❌ | ❌ | ✅ | ❌ | ✅ Disponible |
110114 | Inclusao Condutor | 📤 | ❌ | ❌ | ✅ | ❌ | ✅ Disponible |
112110 | Informação de efetivo pagamento para liberar crédito presumido | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
112120 | Importação em ALC/ZFM não convertida em isenção | 📤 | ✅ | ❌ | ❌ | ❌ | 🚧 En implementación |
112130 | Perecimento, perda, roubo ou furto durante o transporte contratado pelo fornecedor | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
112140 | Fornecimento não realizado com pagamento antecipado | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
112150 | Atualização da Data de Previsão de Entrega | 📤 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
210200 | Confirmação da operação | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
210210 | Ciência da operação | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
210220 | Desconhecimento da operação | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
210240 | Operação não realizada | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
211110 | Solicitação de Apropriação de crédito presumido | 📤📥 | ✅ | ❌ | ❌ | ❌ | 🚧 En implementación |
211124 | Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
211128 | Aceite de débito na apuração por emissão de nota de crédito | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
211130 | Imobilização de Item | 📥 | ✅ | ❌ | ❌ | ❌ | ✅ Disponible |
211140 | Solicitação de Apropriação de Crédito de Combustível | 📥 | ✅ | ❌ | ❌ | ❌ | 🚧 En implementación |
211150 | Solicitação de Apropriação de Crédito para bens e serviços que dependem de atividade do adquirente | 📥 | ✅ | ❌ | ❌ | ❌ | 🚧 En implementación |
Eventos de Reforma Tributária — IBS/CBS
Los nueve eventos 112120, 112130, 112140, 112150, 211110, 211124, 211128, 211130, 211140 y 211150 fueron introducidos por la NT 2025.002-RTC (Reforma Tributária — Lei Complementar nº 214/2025) y aplican únicamente a NF-e modelo 55. Los marcados como 🚧 En implementación están definidos en la NT pero aún no verificados contra el endpoint — su leiaute puede cambiar antes de quedar disponibles.
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
Eventos de Emisor
ChangeDocumentStatus — Request (Eventos de Emisor)
POST /api/v1/Document/ChangeDocumentStatus
?GlobalDocumentId=7b28000c-ae96-f63e-5639-fffdf28c7fd9
&status=110111
&description=Cancelamento+por+erro+no+valor+do+impostoEventos de Receptor
ChangeDocumentStatus — Request (Eventos de Receptor)
POST /api/v1/Document/ChangeDocumentStatus
?GlobalDocumentId=7b28000c-ae96-f63e-5639-fffdf28c7fd9
&status=210200
&description=Confirmacao+da+operacaoChangeDocumentStatus — 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
Basic Auth (v1) u OAuth 2.0 (v2), según el endpoint que uses — ver Autenticación para el detalle y las credenciales.
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
accountCodees obligatorio para los eventos110001,112110y211128. Contiene el CNPJ de la cuenta acreedora involucrada en la operación.stampNumberycodeson obligatorios únicamente para el evento110001(Cancelamento de Evento). Enviarlos en otros eventos puede causar rechazo por parte de SEFAZ.itemsData[n].*es obligatorio para112130,112140y211130, y debe enviarse en el body (ver advertencia de body vs. querystring arriba).dPrevEntregaes obligatorio únicamente para112150.
Diferencia de serialización entre eventos de ítem
Los eventos 211124 y 211130 (receptor) serializan el grupo gPerecimento/gImobilizacao sin duplicar vIBS/vCBS dentro de gControleEstoque. El evento 112130 (emisor) sí replica vIBS/vCBS también dentro de gControleEstoque. Verifica la estructura esperada según el evento antes de integrar.