POST /api/v1/transactions/AuditLog – RetailForce

O ponto final POST /api/v1/transactions/AuditLog permite a adição de uma entrada de evento para o respetivo client fiscal, o que é importante para a rastreabilidade das transações e dos processos internos do sistema e é exigido por lei em alguns países.

Atenção: Os eventos devem ser enviados no momento correto e na ordem correta. Tal como acontece com os documentos, os eventos (auditorias) não devem ser enviados em lote (pacote)!

Resultado

Uma chamada bem-sucedida do ponto de extremidade (200)

adiciona uma entrada de registo de auditoria ao diário de eventos técnicos.

Utilização

Este ponto de extremidade é utilizado para registar eventos que o sistema de caixa registadora é obrigado a registar.

Mapeamento de códigos de evento

As informações relativas ao mapeamento dos códigos de evento do RetailForce para os códigos de evento em países específicos podem ser consultadas na visão geral «Registo técnico de eventos / Registo de eventos».

Requisitos

The fiscal client must be initialized and operational.

Processo de transmissão

O pedido deve ser enviado como um objeto JSON:

{
  "recordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uniqueClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "logEntryType": "100",
  "message": "string",
  "documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": {
    "id": "string",
    "caption": "string",
    "firstName": "string",
    "lastName": "string",
    "taxNumber": "string",
    "dateOfEntry": "2022-01-01T00:00:00+01:00"
  },
  "amount": 0,
  "identifier": "string",
  "recordDateTime": "2023-12-07T10:14:19.859+01:00",
  "signature": "string"
}

Campos do formulário

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

Elemento		Tipo	Descrição
RecordId			identificador único da entrada.
uniqueClientId		M	O uniqueClientId da caixa registadora (do RetailForce system) à qual pertence a entrada do registo de auditoria.
LogEntryType			O tipo da entrada do registo de auditoria.
message			Mensagem da entrada de auditoria.
DocumentGuid			Uma possível ligação a um documento da entrada do registo de auditoria
user			O utilizador (se aplicável) da entrada do registo de auditoria.
	{...}
amount			Montante total do documento
identificador			Um possível identificador para a entrada do registo de auditoria.
dataHoraDoRegisto		M	a data e hora de registo da entrada no registo de auditoria.
assinatura

Exemplo:

// Saving the transaction
{
  "recordId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "uniqueClientId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "LogEntryType": 100,
  "Message": "DocumentTypeSales",
  "documentGuid": "215c2395-ab4a-4132-858d-86459a9e883a",
  "user": {
    "id": "1234",
    "caption": "Max Thomas"
  },
  "amount": 12.5,
  "identifier": "0000001",
  "recordDateTime": "2023-12-07T10:15:45+01:00"
}
// Closing the cash drawer
{
  "recordDateTime": "2023-12-07T10:15:46+01:00",
  "UniqueClientId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "LogEntryType": 201,
  "Message": "DrawerClose",
  "DocumentGuid": null,
  "user": {
    "id": "1234",
    "caption": "Max Thomas"
  }
}

Resposta

Respostas possíveis:

Código	Descrição
200	OK
202	O registo era uma duplicata
422	O parâmetro AuditLog é null ou foi definida uma assinatura para a entrada.

Este artigo foi traduzido automaticamente.