Objeto de referência do documento «documentReference» – RetailForce

Este artigo aborda o objeto de referência do documento «documentReference» no âmbito do objeto Document.

Uma descrição completa do RetailForce DOM (Modelo de Objetos de Documento), bem como uma descrição dos elementos individuais, pode ser consultada na área de downloads do RetailForce website (Documentação do modelo de objetos.pdf), no respetivo diretório de versões.

O objeto «documentReference» é utilizado para fazer referência a outros documentos já criados (emitidos). Trata-se, normalmente, de um documento emitido anteriormente que deve ser anulado na sua totalidade, ou quando é necessário fazer referência a um documento de venda correspondente no âmbito de uma devolução de bens ou serviços.

Objeto documentReference

O objeto de referência de documento a seguir contém dados de exemplo.

"documentReference": {
   "referenceType": "[0] = Cancellation",
   "storeNumber": "999",
   "terminalNumber": "03",
   "documentType": "[0] = Receipt",
   "documentNumber": "2023000748605",
   "documentNumberSeries": "YYYYASCNO",
   "fiscalDocumentNumber": 0,
   "documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "documentId": "999-2023000748605",
   "documentBookDate": "2023-04-27T17:27:12.541Z",
   "returnReasonType": "userMistake",
   "returnReasonText": "cashier error"
},

O objeto de referência de documento contém as seguintes informações.

Informações na coluna «Tipo»:

M ... obrigatório / exigido
M* ... obrigatório / exigido em determinados países ou sob determinadas condições
R ... recomendado
O... opcional

Elementos		Tipo	Descrição
documentReference		M*	documentReference é, essencialmente, um array opcional. Em alguns países, a referência a outros documentos é uma prática comum e, muitas vezes, obrigatória. Caso seja utilizado, são necessárias determinadas especificações.
	ReferenceType	M	Tipo de referência ao documento. Enumeração: [0] = Anulação (remete para um documento anulado / item de documento anulado) [1] = Antecessor (refere-se ao documento anterior)
	storeNumber		O número da agência/loja onde o documento referido foi emitido.
	terminalNumber		O número da caixa registadora na qual o documento referido foi emitido.
	documentType		Tipo de documento do documento em questão.
	DocumentNumber		Número do documento a que se refere.
	documentNumberSeries		Intervalo numérico do documento referido.
	fiscalDocumentNumber		Número fiscal do documento de referência.
	DocumentGuid		GUID / UUID do documento referenciado.
	DocumentId		Número único do documento de referência (máx. 40 caracteres).
	DocumentBookDate		Data e hora de reserva do documento referido.
	ReturnReasonType		Motivo da devolução Enumeração: CustomerComplaint - Reclamações do cliente (incluindo reclamações ao abrigo da garantia) CustomerDiscount - O cliente pretende um desconto no preço do artigo Devolução do Cliente - O cliente pretende devolver o artigo (sem motivo de reclamação) Dados de Referência Errados - Os dados (de referência) do artigo estavam errados (dados errados do artigo) Erro do utilizador - O funcionário da caixa cometeu um erro que deve ser corrigido.
	returnReasonText		Descrição do motivo da devolução.

Este artigo foi traduzido automaticamente.

Objeto documentReference

Artigos relacionados