Reconciliation end of day format
The format of reconciliation-end-of-day: one store and business date, with the day's totals per tender and item and the change since the previous summary of the same day in the fields ending in Delta. What each field means for an integration, and how to consume the event, is in
Receiving the events.
The copy External Events links to is rec.public.event.reconciliation-end-of-day.v1.json.
⚠ The schema's own description names the topic rec.public.event.end-of-day.v1. The topic is rec.public.event.end-of-day-completed.v2, offered in External Events as reconciliation-end-of-day.
{
"id": "hiiretail.contracts.rec.public.event.end-of-day.v1",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "EndOfDay",
"description": "End of day event generated by reconciliation service.\n{\n \"subscription\": \"rec.public.event.end-of-day.v1\",\n \"message\": {\n \"attributes\": {\n \"Tenant-Id\": \"tenantId\",\n \"Business-Unit-Id\": \"businessUnitId\",\n \"Correlation-Id\": \"correlationId\"\n },\n \"data\": \"this.format\"\n }\n}",
"type": "object",
"required": [
"tenantId",
"businessUnitId",
"correlationId",
"endOfDayDate",
"timestamp"
],
"properties": {
"tenantId": {
"type": "string",
"description": "The tenant id for the end of day event"
},
"correlationId": {
"type": "string",
"description": "The correlation id for the end of day event"
},
"businessUnitId": {
"type": "string",
"description": "The business unit id for the end of day event"
},
"userId": {
"type": [
"null",
"string"
],
"description": "The user id of the user submitting the end of day event."
},
"externalUserId": {
"type": [
"null",
"string"
],
"description": "The external user id of the user submitting the end of day event."
},
"endOfDayDate": {
"type": "string",
"format": "date",
"description": "The date (not time) this end of day applies to."
},
"comment": {
"type": [
"null",
"string"
],
"description": "The comment by the user that performed the end of day submit"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp for the end of day event"
},
"reconciliationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of all reconciliation id's included in this end of day event."
},
"tenders": {
"type": "array",
"items": {
"$ref": "#/$defs/EndOfDayTender"
},
"description": "Accumulated values for all tenders in all included reconciliations for this end of day event."
},
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/EndOfDayItem"
},
"description": "Accumulated values for all items in all included reconciliations for this end of day event."
}
},
"$defs": {
"EndOfDayTender": {
"title": "EndOfDayTender",
"type": "object",
"required": [
"tenderId",
"currencyId"
],
"properties": {
"tenderId": {
"type": "string",
"description": " The tender id"
},
"currencyId": {
"type": "string",
"description": "The currency id"
},
"expectedAmount": {
"type": [
"number",
"null"
],
"description": "The expected amount for the tender, i.e. the system accumulated amount based on all reconciliations for this end of day event."
},
"expectedAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the expected amount for the tender compared to the previous amount."
},
"actualAmount": {
"type": [
"number",
"null"
],
"description": "The actual amount counted for the tender."
},
"actualAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the actual amount counted for the tender compared to the previous amount."
},
"deviationAmount": {
"type": [
"number",
"null"
],
"description": "The deviation between counted and expected amount. If negative, it means that counted is less than expected"
},
"deviationAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the deviation between counted and expected amount compared to the previous deviation."
},
"expectedQuantity": {
"type": [
"integer",
"null"
],
"description": "The expected quantity for the tender, i.e. the system accumulated quantity based on all transactions performed."
},
"expectedQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the expected quantity for the tender compared to the previous quantity."
},
"actualQuantity": {
"type": [
"integer",
"null"
],
"description": "The actual quantity of tender."
},
"actualQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the actual quantity counted for the tender compared to the previous count."
},
"deviationQuantity": {
"type": [
"integer",
"null"
],
"description": "The deviation between counted and expected quantity. If negative, it means that counted is less than expected"
},
"deviationQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the deviation between counted and expected quantity compared to the previous deviation."
}
}
},
"EndOfDayItem": {
"title": "EndOfDayItem",
"type": "object",
"required": [
"reconciliationMethod",
"reconciliationTypeCode"
],
"properties": {
"reconciliationMethod": {
"type": "string",
"description": "If AUTOMATIC then item is read only, if MANUAL then item is not read only"
},
"reconciliationTypeCode": {
"type": "string",
"description": "This item reconciliationTypeCode"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the item"
},
"expectedAmount": {
"type": [
"number",
"null"
],
"description": "The expected amount accumulated for the item."
},
"expectedAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the expected amount for the item compared to the previous amount."
},
"actualAmount": {
"type": [
"number",
"null"
],
"description": "The actual amount counted for the item."
},
"actualAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the actual amount counted for the item compared to the previous amount."
},
"deviationAmount": {
"type": [
"number",
"null"
],
"description": "The deviation between counted and expected amount. If negative, it means that counted is less than expected"
},
"deviationAmountDelta": {
"type": [
"number",
"null"
],
"description": "The change in the deviation between counted and expected amount compared to the previous deviation."
},
"expectedQuantity": {
"type": [
"integer",
"null"
],
"description": "The expected quantity for the item, i.e. the system accumulated quantity based on all transactions performed."
},
"expectedQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the expected quantity for the item compared to the previous quantity."
},
"actualQuantity": {
"type": [
"integer",
"null"
],
"description": "The actual amount for the item."
},
"actualQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the actual quantity counted for the item compared to the previous count."
},
"deviationQuantity": {
"type": [
"integer",
"null"
],
"description": "The deviation between counted and expected quantity. If negative, it means that counted is less than expected"
},
"deviationQuantityDelta": {
"type": [
"integer",
"null"
],
"description": "The change in the deviation between counted and expected quantity compared to the previous deviation."
}
}
}
}
}