Este artículo trata sobre el objeto «Header» («pagos»), es decir, los elementos del «Header» dentro del objeto «Document».
En la sección Descargas del sitio web de RetailForce (Documentación del modelo de objetos.pdf), dentro del directorio de la versión correspondiente, se puede encontrar una descripción completa del RetailForce DOM, así como una descripción de los elementos individuales.
Objeto «Header»
{
"uniqueClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationVersion": "6.2.5",
"applicationVersionId": "string",
"applicationVersionPrevious": "string",
"fiscalModuleVersion": "1.8.8",
"fiscalCountryModuleVersion": "1.0.5",
"softwareName": "GreatesPOS",
"retailForceReceiptId": "W3D9C2Q1",
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"automaticVatCalculation": "noCalculation",
"allowedVatDeviation": 0.01,
"terminalSlaveId": "Pad05",
"cashRegisterSerialNumber": "CR123456789",
"footerGraphicIndex": 5,
"auditLogEntryType": "other",
"amount": 0,
"identifier": "string",
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "S962-000001287",
"createDate": "2023-04-27T17:27:12+01:00",
"bookDate": "2023-04-27T17:27:12+01:00",
"accountingDate": "2023-04-27T17:27:12+01:00",
"processStartDate": "2023-04-27T17:27:12+01:00",
"documentNumber": "000001287",
"documentNumberSeries": "Kassenbelege",
"cancellationDocument": false,
"failedToPay": false,
"documentReference": {
"referenceType": "[0] = Cancellation",
"storeNumber": "Restaurant 03",
"terminalNumber": "002",
"documentType": "[0] = Receipt",
"documentNumber": "000000895",
"documentNumberSeries": "Kassenbelege",
"fiscalDocumentNumber": 0,
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "S962-000000895",
"documentBookDate": "2023-04-27T17:27:12+01:00",
"returnReasonType": "userMistake",
"returnReasonText": "Fehler passiert"
},
"isTraining": true,
"testCaseNumber": "string",
"documentType": "[0] = Receipt",
"documentTypeCaption": "Verkaufsbeleg",
"user": {
"id": "03",
"caption": "Bedienung 03",
"firstName": "Franz",
"lastName": "Österreicher",
"taxNumber": "123456789",
"dateOfEntry": "2022-10-01T08:00:00+01:00"
},
"salesPerson": {
"id": "04",
"caption": "Kassier 04",
"firstName": "Sandra",
"lastName": "Hurtig",
"taxNumber": "987654321",
"dateOfEntry": "2022-10-01T08:00:00+01:00"
},
"allocationGroups": [
"Tisch 127"
],
"partner": {
"id": "ABC1234567",
"caption": "Kunde",
"isBusiness": false,
"partnerType": "[0] = Customer",
"partnerClassification": "Privatkunde",
"vatNumber": "n.a.",
"taxNumber": "n.a.",
"identificationType": "passport",
"partnerIdentification": "ABC1234567",
"addressType": "BillingAddress",
"additionalIdentifications": {
"lotteryId": "1234567",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"street": "Musterstraße",
"streetNumber": "186",
"postalCode": "1010",
"city": "Wien",
"community": "n.a.",
"countryCode": "AT"
},
"notes": "Anmerkungen",
"customerCount": 1,
"paymentTerms": {
"dueDateDays": 0,
"discount": 0,
"discountDueDays": 0,
"latePaymentPenaltyRate": 0
},
"servicePeriodStart": "2023-04-27T17:27:12+01:00",
"servicePeriodEnd": "2023-04-27T17:27:12+01:00",
"positionCount": 1,
"documentIssueType": "paper",
"coupon": {
"header": [
{
"text": "string",
"barcodeType": "QrCode",
"barcode": "https://retailforce.cloud"
}
],
"grafic": "string",
"footer": [
{
"text": "string",
"barcodeType": "QrCode",
"barcode": "https://retailforce.cloud"
}
]
},
"serviceType": "string",
"isEcommerceTransaction": true,
"taxPositions": [
{
"vatIdentification": 0,
"vatLabel": "string",
"vatPercent1": 0,
"vatPercent2": 0,
"vatAmount": 0,
"vatAmount2": 0,
"netAmount": 0,
"grossAmount": 0
}
],
"fiscalResponse": {
"fiscalCountry": "[1] = Austria",
"certificationType": "string",
"fiscalisationType": "string",
"supportedPlatformTypes": "string",
"overpaymentNotAllowed": "boolean",
"documentTypeBusinessTransactionTypeSupport": "string",
"fiscalDocumentNumber": "0",
"taxPositions": [
{
"vatIdentification": 0,
"vatLabel": "string",
"vatPercent1": 0,
"vatPercent2": 0,
"vatAmount": 0,
"vatAmount2": 0,
"netAmount": 0,
"grossAmount": 0
}
],
"fiscalDocumentStartTime": 0,
"processStartTime": 0,
"errorDescription": "string",
"cashRegisterId": "string",
"signature": "string",
"userMessage": "string",
"printMessage": "string",
"requestTime": "2023-04-27T17:27:12+01:00",
"requestCompletionTime": "2023-04-27T17:27:12+01:00",
"qrCode": "string",
"printingFields": {},
"AdditionalFields": {}
},
"fiscalDocumentNumber": 0,
"fiscalDocumentRevision": 0,
"FiscalDocumentStartTime": 0,
"positions": [
{
"positionNumber": 0,
"positionReference": {
"positionNumber": 0,
"referenceType": "[0] = Cancellation",
"storeNumber": "string",
"terminalNumber": "string",
"documentType": "[0] = Receipt",
"documentNumber": "string",
"documentNumberSeries": "string",
"fiscalDocumentNumber": 0,
"documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "string",
"documentBookDate": "2023-04-27T17:27:12+01:00",
"returnReasonType": "userMistake",
"returnReasonText": "string"
},
"cancellationPosition": true,
"deletedPosition": false,
"type": "[0] = Item",
"itemCaption": "Sample Item",
"itemId": "ITEM-001",
"itemType": "[0] = Article",
"quantity": 1.0,
"quantityUnit": { "id": "Stk" },
"businessTransactionType": "[0] = Revenue",
"netValue": 10.0,
"grossValue": 12.0,
"taxValue": 2.0,
"ItemDateOfEntry": "2021-08-08T12:00:00+01:00",
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"createDate": "2023-04-27T17:27:12+01:00",
"externalIdentifier": [
"string"
],
"user": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"salesPerson": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"FiscalAdditionalFields": {}
}
],
"payments": [
{
"amount": 12.0,
"currencyIsoCode": "EUR",
"caption": "string",
"uniqueReadablePaymentIdentifier": "string",
"foreignAmount": 0,
"foreignAmountExchangeRate": 0,
"additionalFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"paymentType": "creditCard",
"createDate": "2023-04-27T17:27:12+01:00",
"vatIdentification": 0,
"vatPercent": 0,
"taxValue": 0,
"externalIdentifier": [
"string"
],
"user": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"salesPerson": {
"id": "string",
"caption": "string",
"firstName": "string",
"lastName": "string",
"taxNumber": "string",
"dateOfEntry": "2021-08-08T12:00:00+01:00"
},
"paymentTerminalReferenceId": "string",
"cardData": {
"receiptCopyCount": 0,
"receipt": [
"string"
],
"cardNumberMasked": "string",
"identificationToken": "string",
"merchantCopyCount": 0,
"merchantReceipt": [
"string"
],
"cardType": "VISA",
"authorizationCode": "AUTH123",
"terminalId": "TERM-A1",
"merchantId": "MERCH-B2",
"transactionId": "TRANS-C3",
"providerSignature": "string",
"providerTransactionId": "string",
"providerSignatureMessage": "string",
"transactionDate": "2023-04-27T17:27:12+01:00",
"transactionNumber": "string"
}
}
],
"additionalHeader": [
"string"
],
"additionalFooter": [
"string"
],
"FiscalAdditionalFields": {}
}El objeto «Header» contiene la siguiente información.
Información de la columna «Tipo»:
- M ... obligatorio («mandatory»)
- M* ... obligatorio en determinados países o bajo ciertas condiciones
- R ... recomendado («recomendado»)
- O ... opcional
| Elemento | Tipo | Descripción | |
| uniqueClientId | M | Identificador único del cliente, que se corresponde con el identificador del terminal en RetailForce Cloud (se devuelve o asigna durante la puesta en marcha mediante PUT /api/v1/management/clients/byCloud). | |
| applicationVersion | R/M* |
Versión del software de la caja registradora.
Importante:
Tenga en cuenta que, en algunos países (Francia), el número de versión es fijo como parte del proceso de certificación. Si se especifica un número de versión incorrecto (que no se corresponda con el número certificado), no es posible completar el documento (=error). Consulte también: Versión certificada
.
Datos del país:
|
|
| ApplicationVersionId | R/M* |
ID de la versión del software de la caja registradora. Datos del país:
|
|
| ApplicationVersionPrevious | R/M* |
ID de la versión anterior del software de caja registradora. Detalles del país:
|
|
| FiscalModuleVersion | O/M* | Versión del módulo fiscal (módulo fiscal de confianza) utilizado para generar el documento correspondiente. El middleware la establece automáticamente si no la transmite el software. | |
| FiscalCountryModuleVersion | O/M* | Versión del módulo nacional (Módulo Fiscal Nacional de Confianza) utilizado para generar el documento correspondiente. El middleware la establece automáticamente si el software no la transmite. | |
| FiscalisationType | O | ||
| firma | O | Firma | |
| impresoraFiscal | Impresora fiscal | ||
| en línea | En línea | ||
| firmaConConexiónEnLínea | Firma con conexión en línea | ||
| sin fiscalización | Sin fiscalización | ||
| Tipo de fiscalización: Italia | O | ||
| impresora | O | Registrador telemático | |
| retailForceReceiptId | O | Número de recibo único a nivel global (compuesto por el «terminalId» y el número secuencial del recibo). Se puede generar al crear una transacción (mediante createDocument). | |
| AdditionalFields | O | ||
| additionalProp1-x | O | ||
| automaticVatCalculation | O |
Este elemento activa el cálculo automático de diversos campos de suma a nivel de posición. 0 noCalculation: no se realiza ningún cálculo automático 1 netValueCalculation: cálculo automático del importe neto y del importe del Vat. Se deben especificar, como mínimo, el importe bruto y el porcentaje o la identificación del Vat. 2 cálculo del valor bruto: cálculo automático del importe bruto y del importe del impuesto. Se deben especificar, como mínimo, el valor neto y el porcentaje o la identificación del Vat. |
|
| AllowedVatDeviation | O |
Se puede utilizar para compensar los problemas de redondeo en el cálculo del Vat. Se recomienda utilizarlo con precaución, ya que la asignación de un valor elevado desactiva la validación del cálculo del IVA. Ejemplo: «AllowedVatDeviation»: 0,05, permite una desviación de 5 céntimos entre el valor neto + el valor del impuesto = valor bruto (+-0,05) |
|
| TerminalSlaveId | O | Especificación del ID de un terminal de entrada. | |
| cashRegisterSerialNumber | O |
Número de serie del dispositivo de caja registradora. Este campo identifica el hardware físico específico de la caja registradora utilizado para procesar la transacción. | |
| footerGraphicIndex | O |
Mediante footerGraphicIndex se inserta un elemento gráfico predefinido en el pie de página de un documento. Datos del país:
|
|
| AuditLogEntryType | Especifica el tipo de entrada del registro de auditoría cuando el propio documento constituye una entrada del registro de auditoría. | ||
| amount | Importe asociado a la cabecera del documento (por ejemplo, a efectos del registro de auditoría). | ||
| identifier | Un campo de identificación general (por ejemplo, a efectos del registro de auditoría). | ||
| DocumentGuid | M | Identificador único del documento mediante UUID/GUID. También se utiliza como enlace para los recibos digitales. | |
| DocumentId | M | Número único y secuencial del documento (recibo) dentro de la sucursal, filial o restaurante (en todas las cajas registradoras), asignado por el sistema de caja registradora (máx. 40 caracteres). | |
| CreateDate | M | Hora de creación del documento | |
| BookDate | M | Fecha de reserva | |
| AccountingDate | O | Fecha de contabilización posible para este documento | |
| ProcessStartDate | R/M* | Momento de creación del primer recibo dentro de todo el proceso (p. ej., Alemania: momento de creación del primer pedido de cliente relacionado con el presente recibo de pago; véase también «Características especiales de la hostelería») | |
| SystemEntryDate | O |
Hora en la que se introdujo el documento en el sistema de caja registradora. Datos del país:
|
|
| DocumentNumber | R/M* |
Número único y secuencial del documento (equivalente al «número de recibo»), asignado por el sistema de caja registradora. Detalles por país:
|
|
| ExternalDocumentNumber | O |
Número de documento de un sistema externo. Se utiliza cuando no existe ningún documento interno (por ejemplo, una factura) al que se pueda hacer referencia. Detalles por país:
|
|
| documentNumberSeries | O/M* |
Nombre de la serie numérica del número de recibo (DocumentNumber). Detalles por país:
|
|
| cancellationDocument | M |
Indicador que señala si el presente documento se utiliza para anular otro documento (emitido anteriormente) true: documento de anulación false: no se trata de un documento de cancelación |
|
| ParagonDocument | O |
Flag (true/false) que indica si el documento es el registro posterior de un recibo manuscrito («paragon»), p. ej., tras una avería del sistema de punto de venta. | |
| ParagonNumber | M* |
Número del recibo manuscrito («paragon»). Debe indicarse si «ParagonDocument» es «verdadero» y no debe indicarse en caso contrario; el documento se rechazará si no se cumple esta norma. Datos del país:
|
|
| ParagonIssueDate | M* |
Fecha de emisión del recibo manuscrito (paragon). Debe indicarse si paragonDocument es «true» y no debe indicarse en caso contrario; el documento se rechazará si no se cumple esta norma. Detalles del país:
|
|
| FailedToPay | O |
Bandera booleana (true/false) que indica si el pago asociado al documento ha fallado. |
|
| documentReference | O/M* | Se utiliza para hacer referencia a otro documento. | |
| {...} | |||
| IsTraining | O/M* | Indicador para marcar documentos de formación o demostración (generados en el modo de formación o demostración de la caja registradora). | |
| TestCaseNumber | O/M* |
Campo para especificar un número de caso de prueba con fines de certificación. Datos del país:
|
|
| FriendlyName | O |
Nombre descriptivo opcional para las solicitudes de certificado (normalmente solo se utiliza en entornos de prueba). Datos del país:
|
|
| documentType | O | Especificación del tipo de documento | |
| documentTypeCaption | M* |
Descripción del tipo de documento. Sirve fundamentalmente para ofrecer una descripción más detallada o una aclaración. Datos por países:
|
|
| usuario | O/M* |
Información sobre el usuario (de la caja registradora). Datos del país:
|
|
| {...} | |||
| SalesPerson | O/M* |
Información sobre el personal de ventas. Datos del país:
|
|
| {...} | |||
| AllocationGroups [] | O/M* |
Se utiliza para asignar recibos a elementos específicos (por ejemplo, mesas en el sector de la gastronomía). Véase también: Proceso de pedidos de larga duración en gastronomía. Detalles por país:
|
|
| socio | O/M* |
Información sobre los respectivos socios (comerciales) de la empresa emisora del documento. Detalles del país:
|
|
| addressType | (En el partner objeto) Nuevo campo opcional para especificar el tipo de dirección (p. ej., dirección de facturación). |
||
| {...} | |||
| notas | O | Registro de notas adicionales | |
| CustomerCount | O/M* |
Número de clientes asociados a este documento (por ejemplo, en el sector de la restauración, el número de comensales en caja o en mesa) Datos del país:
|
|
| PaymentTerms | O | Condiciones de pago | |
| {...} | |||
| ServicePeriodStart | O |
Inicio del período de prestación del servicio (especialmente para facturas) Datos del país:
|
|
| ServicePeriodEnd | O |
Fin del período de servicio (especialmente para las facturas) Detalles del país:
|
|
| PositionCount | O/M* |
Número de posiciones que contiene el recibo (todas las posiciones, incluidas las de artículo, texto, reserva, subtotal y total) Véase también Objeto de posición. Datos del país:
|
|
| DocumentIssueType | O/M* |
Define el tipo de emisión del recibo.
Datos del país:
|
|
| cupón | O | Posibilidad de imprimir cupones adicionales y otros elementos en el recibo. | |
| {...} | |||
| serviceType | O/M* |
Especificación del tipo de servicio en el sector de la restauración (mesa, servicio en barra). Valores posibles (¡se debe respetar la convención CamelCase!)
Datos del país:
|
|
| ¿Se trata de una transacción de comercio electrónico? | O/M* |
Indicación de si se trata de una transacción de comercio electrónico (true / false). Datos del país:
|
|
| TaxPositions | R |
Especificación de todas las posiciones de Vat del documento. Deben especificarse todas las posiciones de Vat o ninguna. Para obtener las posiciones fiscales del documento (cuando no se haya establecido esta propiedad), utilice GetTaxPositions(Document, boolean).
Nota sobre Austria:
Recomendamos utilizar esta matriz para transmitir las posiciones fiscales de un recibo con el fin de evitar problemas de redondeo en el protocolo de registro de datos («DEP7»).
|
|
| {...} | |||
| fiscalResponse | - |
Respuesta del servicio de fiscalización tras la transmisión de createDocument y storeDocument. Se recomienda persistir el contenido de fiscalResponse en la base de datos de la caja registradora.
Nota:
determinados campos del objeto fiscalResponse, tras la ejecución de la función createDocument
, deben incluirse en el documento JSON (que debe enviarse a storeDocument
). No incluya el objeto fiscalResponse completo.
|
|
| {...} | |||
| fiscalDocumentNumber | M* |
Número de documento fiscal (asignado por el RetailForce system o por la unidad de fiscalización correspondiente; p. ej., la TSE en Alemania)
Atención:
Tenga en cuenta que, en los sistemas hasta la versión 1.7.7, la información fiscalDocumentNumber se devolvía en el campo fiscalisation
DocumentNumber del objeto fiscalResponse. Véase también el artículo: «Transacción dada no iniciada
». En la versión 1.7.7 se introdujo un campo adicional, fiscalDocumentNumber (string), en el objeto fiscalResponse.
|
|
| fiscalDocumentRevision | O/M* |
Número de revisión del documento fiscal (asignado por el RetailForce system o por la unidad de fiscalización correspondiente —por ejemplo, la TSE en Alemania—)
Atención:
Tenga en cuenta que, en los sistemas hasta la v1.7.7, la propiedad «fiscalDocumentRevision» se devolvía en el campo «fiscalisationDocumentRevision» del header del objeto «fiscalResponse». Véase también el artículo: «La transacción indicada no se ha iniciado
». A partir de la v1.7.7, la propiedad del objeto «fiscalResponse» pasó a denominarse «fiscalDocumentRevision» y ahora solo se devuelve en la matriz «AdditionalFields» del objeto «fiscalResponse-Germany».
|
|
| fiscalDocumentStartTime | M* | Hora de creación del documento fiscal (asignada por el RetailForce system o por la unidad de fiscalización correspondiente; p. ej., TSE en Alemania) | |
| DocumentPosition | M | Información sobre la posición correspondiente del recibo o documento (el contenido depende del tipo de documento y de la posición: «documentType», «positionType») | |
| {...} | |||
| pagos | O/M* | Información sobre el pago (su uso depende del tipo de documento —documentType—) | |
| {...} | |||
| AdditionalHeader | O |
La matriz «AdditionalHeader» puede utilizarse para establecer líneas adicionales de texto libre en el encabezado del documento. Detalles por país:
Nota: Actualmente, este array solo es compatible en Italia. También se puede rellenar en otros países, pero no surtirá efecto. |
|
| AdditionalFooter | O |
La matriz AdditionalFooter se puede utilizar para establecer líneas adicionales de texto libre en el Footer del documento. Detalles por país:
Nota: Actualmente, esta matriz solo es compatible en Italia. También se puede rellenar en otros países, pero no surtirá efecto. |
|
| FiscalAdditionalFields | O | ||
Este artículo ha sido traducido automáticamente.
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.