ChangeDocumentStatus

Executes events on an already-sent document: cancellation, correction letter, operation confirmation, among others.

Endpoint

Available in both API versions — see Authentication to choose the one that applies to you.

Basic Auth — v1

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

PRODUCTIONhttps://developers.gosocket.net/api/v1/Document/ChangeDocumentStatus

OAuth 2.0 — v2

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

PRODUCTIONhttps://developers.gosocket.net/api/v2/Document/ChangeDocumentStatus

Method: POST

Parameters as querystring

Parameters are sent in the URL as a querystring, not in the body. The request body is empty.

Exception — Reforma Tributária events with itemsData

Events 112130, 112140 and 211130 (see table below) require sending an array of items (itemsData) that cannot be expressed as a flat querystring. For these three events, all parameters —including GlobalDocumentId, status and description— are sent in the body as application/x-www-form-urlencoded, not in the URL. Event 112150 does follow the standard querystring pattern (it does not use itemsData).

Input parameters

AtributoTipoDescripción

GlobalDocumentIdstringUnique global identifier of the document on the Gosocket platform. Required.

statusstringCode of the operation or event to execute. See table of allowed values below. Required.

descriptionstringReason why the operation or event is issued. Required.

accountCodestringCNPJ of the creditor account. Conditional: required for events 110001, 112110 and 211128.

stampNumberstringSEFAZ protocol of the event related to the cancellation. Conditional: only applies to event 110001.

codestringCode of the related event type. Conditional: only applies to event 110001.

dPrevEntregastringNew estimated delivery date (previsão de entrega), format "yyyy-MM-dd". Mapped to <dPrevEntrega> in the event XML. Conditional: required only for event 112150.

itemsData[n].quantitystringQuantity of the item affected by the event (0-indexed array). Mapped to qImobilizado / qPerecimento / qNaoFornecida within gControleEstoque, depending on the event. Conditional: required for events 112130, 112140 and 211130.

itemsData[n].unitstringUnit of measure of the item (e.g. "UN"). Mapped to uImobilizado / uPerecimento / uNaoFornecida within gControleEstoque. Conditional: required for events 112130, 112140 and 211130.

itemsData[n].ibsValuestringIBS (Imposto sobre Bens e Serviços) amount of the item, from the Reforma Tributária. Mapped to <vIBS>. Conditional: required for events 112130, 112140 and 211130.

itemsData[n].cbsValuestringCBS (Contribuição sobre Bens e Serviços) amount of the item, from the Reforma Tributária. Mapped to <vCBS>. Conditional: required for events 112130, 112140 and 211130.

itemsData[n].gibsValue / itemsData[n].gcbsValuestringIBS/CBS credit reversal amount related to acquisitions (gControleEstoque group, P31/P32), specific to event 112130.

Allowed values for status

Code	Description	Process	NF-e	CT-e	MDF-e	NFS-e	Status
1009	Inutilização	📤	✅	❌	❌	❌	✅ Available
110001	Cancelamento de Evento	📤	✅	❌	❌	❌	✅ Available
110110	Carta de correção	📤	✅	✅	❌	❌	✅ Available
110111	Cancelamento	📤	✅	✅	✅	✅	✅ Available
110112	Encerramento	📤	❌	❌	✅	❌	✅ Available
110114	Inclusao Condutor	📤	❌	❌	✅	❌	✅ Available
112110	Informação de efetivo pagamento para liberar crédito presumido	📤	✅	❌	❌	❌	✅ Available
112120	Importação em ALC/ZFM não convertida em isenção	📤	✅	❌	❌	❌	🚧 In implementation
112130	Perecimento, perda, roubo ou furto durante o transporte contratado pelo fornecedor	📤	✅	❌	❌	❌	✅ Available
112140	Fornecimento não realizado com pagamento antecipado	📤	✅	❌	❌	❌	✅ Available
112150	Atualização da Data de Previsão de Entrega	📤	✅	❌	❌	❌	✅ Available
210200	Confirmação da operação	📥	✅	❌	❌	❌	✅ Available
210210	Ciência da operação	📥	✅	❌	❌	❌	✅ Available
210220	Desconhecimento da operação	📥	✅	❌	❌	❌	✅ Available
210240	Operação não realizada	📥	✅	❌	❌	❌	✅ Available
211110	Solicitação de Apropriação de crédito presumido	📤📥	✅	❌	❌	❌	🚧 In implementation
211124	Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente	📥	✅	❌	❌	❌	✅ Available
211128	Aceite de débito na apuração por emissão de nota de crédito	📥	✅	❌	❌	❌	✅ Available
211130	Imobilização de Item	📥	✅	❌	❌	❌	✅ Available
211140	Solicitação de Apropriação de Crédito de Combustível	📥	✅	❌	❌	❌	🚧 In implementation
211150	Solicitação de Apropriação de Crédito para bens e serviços que dependem de atividade do adquirente	📥	✅	❌	❌	❌	🚧 In implementation

Reforma Tributária events — IBS/CBS

Events 112120, 112130, 112140, 112150, 211110, 211124, 211128, 211130, 211140 and 211150 were introduced by NT 2025.002-RTC (Reforma Tributária — Lei Complementar nº 214/2025) and apply only to NF-e model 55. Those marked 🚧 In implementation are defined in the NT but not yet verified against the endpoint — their layout may change before they become available.

Response parameters

AtributoTipoDescripción

Successbooleantrue — the operation was successful.

GlobalDocumentIdstringUnique global identifier of the document on the Gosocket platform.

CountryDocumentIdstringChave de acesso of the document (44 digits).

OtherData.ProtocolNumberstringGUID of the internal protocol of the event processed by NDD. Example: "966244f4-fa50-4987-902c-f6432c9461f1".

OtherData.ProtocolSefazstringProtocol number assigned by SEFAZ.

OtherData.IssueDatestringDate and time of the event in ISO 8601 format with timezone. Example: "2026-06-02T18:47:36-03:00".

OtherData.SeriesNumberstringSeries number of the affected document.

OtherData.DatastringInternal NDD response encoded in Base64. Contains the event XML and traceability data.

OtherData.CountrystringCountry code. Always "br".

OtherData.CertifierstringCertifier. Always "NDD" for this integration.

OtherData.AuthorityTimeStampstringDate and time the event was registered. Format: "dd/MM/yyyy HH:mm:ss".

MessagesarrayList of additional messages. Empty if there are no errors.

ResponseValuestringProcessed event XML encoded in Base64.

CodestringSEFAZ cStat code propagated by NDD. This is the **event** response code, not the document authorization code. Examples: "135" (event registered and linked to the document), "136" (event registered but not linked — typical of EPEC when the document does not yet exist in SEFAZ).

DescriptionstringResult description emitted by NDD. Example: "Evento registrado com sucesso, Cancelamento".

ErrorExceptionobjectnull if there is no error.

Examples

Issuer events

ChangeDocumentStatus — Request (Issuer events)

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

Receiver events

ChangeDocumentStatus — Request (Receiver events)

POST /api/v1/Document/ChangeDocumentStatus
?GlobalDocumentId=7b28000c-ae96-f63e-5639-fffdf28c7fd9
&status=210200
&description=Confirmacao+da+operacao

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
}

Notes

Authentication

Basic Auth (v1) or OAuth 2.0 (v2), depending on the endpoint you use — see Authentication for details and credentials.

AP reception operations

Events 210200, 210210, 210220 and 210240 correspond to receiver operation confirmation and only apply to NF-e. For other document types, use only the events listed as compatible in the table.

Conditional parameters

• accountCode is required for events 110001, 112110 and 211128. Contains the CNPJ of the creditor account involved in the operation.
• stampNumber and code are required only for event 110001 (Cancelamento de Evento). Sending them in other events may cause rejection by SEFAZ.
• itemsData[n].* is required for 112130, 112140 and 211130, and must be sent in the body (see the body vs. querystring warning above).
• dPrevEntrega is required only for 112150.

Serialization difference between item events

Receiver events 211124 and 211130 serialize the gPerecimento/gImobilizacao group without duplicating vIBS/vCBS inside gControleEstoque. Issuer event 112130 does replicate vIBS/vCBS inside gControleEstoque as well. Verify the expected structure for each event before integrating.