From 5a3c7700d8f2484b6ca77b48af7e9a9fda7f5694 Mon Sep 17 00:00:00 2001 From: Anjali Selvaraj Date: Tue, 6 May 2025 13:23:48 -0700 Subject: [PATCH 1/2] ERS-33145 fix typos and correction --- .../expense/v4.expense-events-new.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/src/event-topics/expense/v4.expense-events-new.md b/src/event-topics/expense/v4.expense-events-new.md index 9cfaa7a66..261432b9d 100644 --- a/src/event-topics/expense/v4.expense-events-new.md +++ b/src/event-topics/expense/v4.expense-events-new.md @@ -3,7 +3,7 @@ title: Concur Expense Event layout: reference --- -# Concur Expense Event +# Concur Expense Report Events ## Overview @@ -26,7 +26,7 @@ This section lists all the publicly available events. ### Report Created Event -The `reportCreated` event is intended to be published when a new expense report has been created. +The `reportCreated` event is published when a new expense report is created. ### Report Updated Event @@ -73,7 +73,7 @@ In addition to the above, any workflow step configured for notifications by the | `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `facts` | `Map` | [facts schema](#report-created-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | -### Report Created Facts Schema +### Facts Schema for Report Created | Name | Type | Format | Description | |--------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -97,17 +97,17 @@ In addition to the above, any workflow step configured for notifications by the | `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `facts` | `Map` | [facts schema](#report-updated-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | -### Report Updated Facts Schema +### Facts Schema for Report Updated -| Name | Type | Format | Description | -|--------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `companyId` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | -| `userId` | `UUID` | RFC 4122 | The unique identifier of the report creator unless a delegate or proxy is involved. In these instances, it will be the user for which the report is being created (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | -| `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy created the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | -| `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the newly created expense report. Maximum characters: 20 | -| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to create the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | -| `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -| `href` | `string` | RFC 3986 | URI of the report resource that can be called via the Expense v4 API. | +| Name | Type | Format | Description | +|--------------------|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `companyId` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | +| `userId` | `UUID` | RFC 4122 | The unique identifier of the report creator unless a delegate or proxy is involved. In these instances, it will be the user for which the report was updated (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | +| `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy updated the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | +| `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the updated expense report. Maximum characters: 20 | +| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to update the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | +| `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | +| `href` | `string` | RFC 3986 | URI of the report resource that can be called via the Expense v4 API. | ### Report Deleted Event Schema @@ -121,16 +121,16 @@ In addition to the above, any workflow step configured for notifications by the | `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `facts` | `Map` | [facts schema](#report-deleted-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | -### Report Deleted Facts Schema +### Facts Schema for Report Deleted -| Name | Type | Format | Description | -|--------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `companyId` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | -| `userId` | `UUID` | RFC 4122 | The unique identifier of the report creator unless a delegate or proxy is involved. In these instances, it will be the user for which the report is being created (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | -| `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy created the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | -| `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the newly created expense report. Maximum characters: 20 | -| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to create the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | -| `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | +| Name | Type | Format | Description | +|--------------------|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `companyId` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | +| `userId` | `UUID` | RFC 4122 | The unique identifier of the report deleter unless a delegate or proxy is involved. In these instances, it will be the user for whose report is deleted (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | +| `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy deleted the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | +| `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the deleted expense report. Maximum characters: 20 | +| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to delete the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | +| `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | ### Report Status Changed Event Schema @@ -144,7 +144,7 @@ In addition to the above, any workflow step configured for notifications by the | `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `facts` | `Map` | [facts schema](#status-changed-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | -### Report Status Changed Facts Schema +### Facts Schema for Report Status Changed | Name | Type | Format | Description | |--------------------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| From 4d723eca8f3c0d4888f8aef8c45feec48915cb1e Mon Sep 17 00:00:00 2001 From: Anjali Selvaraj Date: Mon, 12 May 2025 09:54:51 -0700 Subject: [PATCH 2/2] ERS-33145 merge event schemas --- .../expense/v4.expense-events-new.md | 70 +++++-------------- 1 file changed, 17 insertions(+), 53 deletions(-) diff --git a/src/event-topics/expense/v4.expense-events-new.md b/src/event-topics/expense/v4.expense-events-new.md index 261432b9d..6f777bda8 100644 --- a/src/event-topics/expense/v4.expense-events-new.md +++ b/src/event-topics/expense/v4.expense-events-new.md @@ -30,7 +30,7 @@ The `reportCreated` event is published when a new expense report is created. ### Report Updated Event -The `reportUpdated` event is published when an expense report is updated. +The `reportUpdated` event is published when a value in the expense report header is updated. This event is not published for the workflow status changes of the report. ### Report Deleted Event @@ -38,9 +38,9 @@ The `reportDeleted` event is published when an expense report is deleted. ### Report Status Changed Event -The `statusChanged` event is intended to publish a message whenever the status of an expense report changes as it traverses the approval workflow during its life cycle. Subscribers of the event are able to leverage the data in the message to perform synchronous or asynchronous actions depending on their business processes. For example, this could trigger an application to make API calls to Concur Expense or start of a process in a third party application. +The `statusChanged` event is published whenever the status of an expense report changes as it traverses the approval workflow during its life cycle. Subscribers of the event are able to leverage the data in the message to perform synchronous or asynchronous actions depending on their business processes. For example, this could trigger an application to make API calls to Concur Expense or start of a process in a third party application. -The `statusChanged` event will always be published for the following status changes without any additional configuration: +The `statusChanged` event will always be published for the following workflow status changes without any additional configuration: * Whenever a report is submitted. * Whenever a report is sent back to the employee by an approver/processor. @@ -61,17 +61,17 @@ In addition to the above, any workflow step configured for notifications by the ## Schema -### Report Created Event Schema +### Event Schema for Expense Report Events -| Name | Type | Format | Description | -|-----------------|-------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| `id` | `UUID` | RFC 4122 | **Required** Randomly generated unique identifier of this event. | -| `correlationId` | `UUID` | RFC 4122 | **Required** Unique identifier used for logging/traceability. | -| `route` | `String` | `String` | For internal use. This will be set to stable. | -| `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | -| `eventType` | `String` | `String` | **Required** Event Type: `reportCreated` - Identifies the event type on the topic. | -| `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -| `facts` | `Map` | [facts schema](#report-created-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | +| Name | Type | Format | Description | +|-----------------|-------------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| `id` | `UUID` | RFC 4122 | **Required** Randomly generated unique identifier of this event. | +| `correlationId` | `UUID` | RFC 4122 | **Required** Unique identifier used for logging/traceability. | +| `route` | `String` | `String` | For internal use. This will be set to stable. | +| `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | +| `eventType` | `String` | `String` | **Required** Identifies the event type on the topic. Event Type: `reportCreated` / `reportUpdated` / `reportDeleted` / `statusChanged` | +| `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | +| `facts` | `Map` | [facts schema](#report-created-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | ### Facts Schema for Report Created @@ -81,46 +81,22 @@ In addition to the above, any workflow step configured for notifications by the | `userId` | `UUID` | RFC 4122 | The unique identifier of the report creator unless a delegate or proxy is involved. In these instances, it will be the user for which the report is being created (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | | `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy created the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | | `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the newly created expense report. Maximum characters: 20 | -| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to create the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | +| `reportType` | `String` | `Enum` | **Required** This value identifies the type of the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | | `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `href` | `string` | RFC 3986 | URI of the report resource that can be called via the Expense v4 API. | -### Report Updated Event Schema - -| Name | Type | Format | Description | -|-----------------|-------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| `id` | `UUID` | RFC 4122 | **Required** Randomly generated unique identifier of this event. | -| `correlationId` | `UUID` | RFC 4122 | **Required** Unique identifier used for logging/traceability. | -| `route` | `String` | `String` | For internal use. This will be set to stable. | -| `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | -| `eventType` | `String` | `String` | **Required** Event Type: `reportUpdated` - Identifies the event type on the topic. | -| `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -| `facts` | `Map` | [facts schema](#report-updated-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | - ### Facts Schema for Report Updated | Name | Type | Format | Description | |--------------------|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `companyId` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | -| `userId` | `UUID` | RFC 4122 | The unique identifier of the report creator unless a delegate or proxy is involved. In these instances, it will be the user for which the report was updated (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | +| `userId` | `UUID` | RFC 4122 | The unique identifier of the report updater unless a delegate or proxy is involved. In these instances, it will be the user for which the report was updated (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | | `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy updated the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | | `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the updated expense report. Maximum characters: 20 | -| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to update the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | +| `reportType` | `String` | `Enum` | **Required** This value identifies the type of the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | | `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | `href` | `string` | RFC 3986 | URI of the report resource that can be called via the Expense v4 API. | -### Report Deleted Event Schema - -| Name | Type | Format | Description | -|-----------------|-------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| `id` | `UUID` | RFC 4122 | **Required** Randomly generated unique identifier of this event. | -| `correlationId` | `UUID` | RFC 4122 | **Required** Unique identifier used for logging/traceability. | -| `route` | `String` | `String` | For internal use. This will be set to stable. | -| `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | -| `eventType` | `String` | `String` | **Required** Event Type: `reportDeleted` - Identifies the event type on the topic. | -| `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -| `facts` | `Map` | [facts schema](#report-deleted-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | - ### Facts Schema for Report Deleted | Name | Type | Format | Description | @@ -129,21 +105,9 @@ In addition to the above, any workflow step configured for notifications by the | `userId` | `UUID` | RFC 4122 | The unique identifier of the report deleter unless a delegate or proxy is involved. In these instances, it will be the user for whose report is deleted (i.e., the report owner).
This value can be NULL when a system initiates the change action instead of a user. This would include API calls with a Company JWT.
Use Identity v4 API to retrieve user details. | | `actingUserId` | `UUID` | RFC 4122 | User unique identifier. If a delegate or expense proxy deleted the report on behalf of another user, then this will be populated with the identifier for that delegate or expense proxy user, else it will be NULL.
Use Identity v4 API to retrieve user details. | | `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the deleted expense report. Maximum characters: 20 | -| `reportType` | `String` | `Enum` | **Required** This value identifies the method used to delete the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | +| `reportType` | `String` | `Enum` | **Required** This value identifies the type of the report. Supported values:
Regular,
Reconciliation,
Statement,
AutoCreated | | `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -### Report Status Changed Event Schema - -| Name | Type | Format | Description | -|-----------------|-------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------| -| `id` | `UUID` | RFC 4122 | **Required** Randomly generated unique identifier of this event. | -| `correlationId` | `UUID` | RFC 4122 | **Required** Unique identifier used for logging/traceability. | -| `route` | `String` | `String` | For internal use. This will be set to stable. | -| `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | -| `eventType` | `String` | `String` | **Required** Event Type: `statusChanged` - Identifies the event type on the topic. | -| `timeStamp` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | -| `facts` | `Map` | [facts schema](#status-changed-event-payload-facts-schema) | **Required** Key-value pairs providing the content of the event. | - ### Facts Schema for Report Status Changed | Name | Type | Format | Description |