Manual Journal Entry Service API
Manual-Journal-Entries
>
Manual Journal Entry Service API
openapi: 3.0.3
info:
title: Manual Journal Entry APIs - Manual Journal Entry Service API
version: v1
description: |
Manual Journal Entry APIs.
contact:
name: Platform Services - Manual Journal Entry
url: https://www.jackhenry.com/
email: DC-Operations@jackhenry.com
servers:
- url: http://jx-r.jhacorp.com
description: Corporate Test Server
security: []
components:
securitySchemes:
bearerAuth:
description: OpenIDConnect JWT Token
type: http
scheme: bearer
bearerFormat: JWT
tags:
- name: Manual Journal Entry Service API
description: Manual Journal Entry Service OpenAPI Definitions
paths:
/a/api/platform/v1/{InstitutionUniversalId}/manual-journal-entry:
post:
tags:
- Manual Journal Entry Service API
description: The API used to process journal entries.
operationId: CreateManualJournalEntry
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
- name: X-Request-ID
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
in: header
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
- name: X-Correlation-ID
description: |
The `X-Correlation-ID` header is an optional header that can be included in REST API to track and correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
in: header
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
- name: X-WorkflowCorrelationId
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
in: header
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
acctSvcsLineItems:
type: array
items:
type: object
properties:
accountId:
type: string
format: uuid
description: The unique account services account identifier.
glAccountId:
type: string
format: uuid
description: The unique general ledger account identifier.
description:
type: string
maximum: 100
amount:
type: object
properties:
value:
type: string
description: This defines the amount value.
nullable: false
currencyType:
type: string
description: The ISO 4217 three character currency type. USD is the default value.
nullable: true
default: usd
additionalProperties: false
debitCredit:
type: string
enum:
- Debit
- Credit
required:
- accountId
- glAccountId
- description
- amount
- debitCredit
glLineItems:
type: array
items:
type: object
properties:
glAccountId:
type: string
format: uuid
description: The unique general ledger account identifier.
description:
type: string
maximum: 100
amount:
type: object
properties:
value:
type: string
description: This defines the amount value.
nullable: false
currencyType:
type: string
description: The ISO 4217 three character currency type. USD is the default value.
nullable: true
default: usd
additionalProperties: false
debitCredit:
type: string
enum:
- Debit
- Credit
required:
- glAccountId
- description
- amount
- debitCredit
responses:
'201':
description: Created
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/json:
schema:
type: object
properties:
id:
type: string
'400':
description: |
Bad Request: The server could not understand the request due to an invalid request.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/problem+json:
schema:
type: object
required:
- type
- title
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
title:
description: A user readable string title of the error type.
type: string
details:
description: An array of strings which provide additional details for the error message.
type: array
items:
type: string
data:
description: An array of strings which provide additional data for the error message.
type: array
items:
type: object
properties:
description:
type: string
element:
type: string
elementValue:
type: string
'401':
description: |
Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'403':
description: |
Forbidden: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'404':
description: |
Not Found: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'500':
description: |
Unexpected Error: An unexpected internal server error occurred while processing the request.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/problem+json:
schema:
type: object
required:
- type
- title
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
title:
description: A user readable string title of the error type.
type: string
details:
description: An array of strings which provide additional details for the error message.
type: array
items:
type: string
data:
description: An array of strings which provide additional data for the error message.
type: array
items:
type: object
properties:
description:
type: string
element:
type: string
elementValue:
type: string
examples:
internalServerError:
summary: Internal server error
value:
type: general/internal-server-error
title: Internal server error
details:
- Unexpected internal server error
/a/api/platform/v1/{InstitutionUniversalId}/manual-journal-entry/all:
get:
tags:
- Manual Journal Entry Service API
description: The API used to get all journal entries between two dates.
operationId: GetAllManualJournalEntriesByDates
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
- name: X-Request-ID
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
in: header
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
- name: X-Correlation-ID
description: |
The `X-Correlation-ID` header is an optional header that can be included in REST API to track and correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
in: header
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
- name: X-WorkflowCorrelationId
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
in: header
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
- name: CreateDateStart
in: query
description: Start date of journal entry CreatedAt.
schema:
type: string
format: date
- name: CreateDateEnd
in: query
description: End date of journal entry CreatedAt.
schema:
type: string
format: date
- name: Offset
in: query
required: false
description: |
When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records.
Example: `.../resource?Offset=50`
schema:
type: string
default: '0'
- name: Count
in: query
required: false
description: |
The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records.
Example: `.../resource?Count=100`'
schema:
type: string
default: '100'
responses:
'200':
description: Success
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/json:
schema:
type: object
properties:
journals:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier of the journal entry.
format: uuid
description:
type: string
description: The description of the journal entry.
createdAt:
type: string
format: date
description: The date and time the journal entry was created.
paging:
type: object
properties:
NextOffset:
description: 'The next offset is the start position of the read pointer for pagination '
type: string
Results:
description: The number of records sent for pagination
type: integer
Total:
description: The total number of records requested for pagination
type: integer
'400':
description: |
Bad Request: The server could not understand the request due to an invalid request.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/problem+json:
schema:
type: object
required:
- type
- title
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
title:
description: A user readable string title of the error type.
type: string
details:
description: An array of strings which provide additional details for the error message.
type: array
items:
type: string
data:
description: An array of strings which provide additional data for the error message.
type: array
items:
type: object
properties:
description:
type: string
element:
type: string
elementValue:
type: string
'401':
description: |
Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'403':
description: |
Forbidden: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'404':
description: |
Not Found: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
'500':
description: |
Unexpected Error: An unexpected internal server error occurred while processing the request.
headers:
X-Request-ID:
description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n"
required: false
schema:
type: string
format: uuid
example: 368b8d8f-5d07-4612-9523-d92fd57b0341
X-Correlation-ID:
description: |
The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction.
required: false
schema:
type: string
format: uuid
example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7
X-WorkflowCorrelationId:
description: |
The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier.
required: false
schema:
type: string
format: uuid
example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60
content:
application/problem+json:
schema:
type: object
required:
- type
- title
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
title:
description: A user readable string title of the error type.
type: string
details:
description: An array of strings which provide additional details for the error message.
type: array
items:
type: string
data:
description: An array of strings which provide additional data for the error message.
type: array
items:
type: object
properties:
description:
type: string
element:
type: string
elementValue:
type: string
examples:
internalServerError:
summary: Internal server error
value:
type: general/internal-server-error
title: Internal server error
details:
- Unexpected internal server error
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Thu Jul 16 2026