--- openapi: 3.0.1 info: title: Analytics API for Adra Balancer description: |- The Analytics ETL API is designed for extracting and analyzing metrics and data from the Adra Balancer application. This API provides access to transformed and aggregated data specifically for reporting and analysis purposes. Purpose: Use this API for analytical queries and metric gathering, not for general Balancer operations. Data Access: The endpoints expose data through OData, enabling flexible querying and easy integration with Business Intelligence (BI) tools. version: '1.0' contact: name: API Support url: https://success.adra.com/s/ email: support@adra.com license: name: Propietary License url: https://www.trintech.com/terms-and-conditions/adra/ x-feedbackLink: url: https://success.adra.com/s/resources/ideas label: Give Feedback servers: - url: https://analyticsapi.adra.com/balancer description: Production server - url: https://analyticsapi.adrastage.com/balancer description: Stage server - url: https://analyticsapi.adratest.com/balancer description: Test server - url: https://analyticsapi.adradev.com/balancer description: Dev server externalDocs: description: Adra Success Center url: https://success.adra.com/s/knowledge-center paths: "/api/AccountDimensions": get: tags: - AccountDimensions summary: Get the account dimensions. description: "This request should be used to retrieve the account dimension data for specified engagement(s). This includes account hierarchies, classifications, and configuration details. The data contained here will be similar to what can be seen in Balancer under Administration->Account settings.\r\n " operationId: api/AccountDimensions parameters: - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json: schema: type: array items: "$ref": "#/components/schemas/AccountDim" example: - Account_Key: 294099 BaseClass: Not set Engagement_Key: 4316 ParentAccount_Key: 0 AccountClass: Asset AccountType: Normal IsKeyAccount: 'True' ReconciliationType: Basic RiskType: Low PrepareFrequency: Month end ApproveFrequency: Month end ReviewFrequency: Month end Account_Id: 119097 ParentAccountId: 0 AccountNumber: '1000' AccountName: General Account Account: 1000100 General Account AccountSubClass: SystemCertify: Not allowed CarryForward: Never AccountProcedure: '' AccountPurpose: '' LegalEntity_Key: 651242 application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountDim" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountDim" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/AccountFacts": get: tags: - AccountFacts summary: Gets the account facts. description: "This request should be used to retrieve account fact data including balances, status, and assigned users for the specified period and engagement(s). The data contained here will be similar to what can be seen in Balancer under Accounts and Status.\r\n " operationId: api/AccountFacts parameters: - name: period in: query description: 'possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99' schema: type: string - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" example: - Engagement_Key: 4316 LegalEntity_Key: 7854 Period_Key: 14631 Account_Key: 1000011 FiscalYearPeriod_Key: 256857 PreparerUsername: PreparerName: ApproverUsername: ApproverName: ReviewerUsername: ReviewerName: AssignedToUsername: peter@westbank.com AssignedToName: Peter AccountStatus: Approved AccountStatusReason: Other IsFinalized: 'False' IsCarriedForward: 'False' BalancerAccountUrl: https://balancer.adra.com/accountperiods/1000011 AccountCreatedInPeriod: '2015-05-05T13:04:45.332Z' NoOfDocuments: 0 NoOfPreparers: 1 NoOfApprovers: 1 NoOfReviewers: 1 Balance: 81833.09 BalanceAbs: 81833.09 UnidentifiedBalance: 0.01 UnIdentifiedBalanceAbs: 0.01 BalanceEngagement: 81833.09 BalanceEngagementAbs: 81833.09 UnidentifiedBalanceEngagement: 0.01 UnIdentifiedBalanceEngagementAbs: 0.01 StatusComment: l.ll AccountPurpose: Purpose of account text. AccountProcedure: Account reconciliation procedure text. ExtraField01: ExtraField02: ExtraField03: ExtraField04: ExtraField05: ExtraField06: ExtraField07: ExtraField08: ExtraField09: ExtraField10: NoOfRejects: 1 AccountPeriodComment_Key: 294137 AccountPeriodTransaction_Key: 294137 PreparedByName: PreparedByUsername: ApprovedByName: ApprovedByUsername: ReviewedByName: ReviewedByUsername: PreparedDate: ApprovedDate: ReviewedDate: RejectedDate: '2015-11-09T14:34:34.543Z' AccountStatusPartial: Approved AccountPeriodBalance: 0.34 BalanceUpdatedDate: '2022-12-05T05:35:43.287Z' AccountStatusComments: AccountStatusReasonText: ReviewComment: application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountFacts" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/AccountVarianceFacts": get: tags: - AccountVarianceFacts summary: Gets the account variance facts. description: "This request should be used to retrieve account variance information comparing balances between periods for the specified engagement(s). The data contained here will be similar to what can be seen in Balancer under the Variance Analysis tab.\r\n " operationId: api/AccountVarianceFacts parameters: - name: period in: query description: 'possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99' schema: type: string - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" example: - AccountPeriodVariance_Key: 1324 Engagement_Key: 9876 LegalEntity_Key: 3423 Account_Key: 9768 Period_Key: 123 VarianceSetting_Key: 231 CurrentPeriod_Key: 435 ComparedPeriod_Key: 4532 Account_Id: 23536 VarianceType: 2 VarianceTypeText: Month Over Month CurrentPeriodBalance: 0.23 ComparedPeriodBalance: 0.11 VarianceAmount: 1.34 VariancePercent: '1.23' Materiality: 2 MaterialityText: Explanation: DocumentedDate: '2022-12-05T06:50:44.992Z' DocumentedBy: IsActive: true application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/AccountVarianceFacts" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/CommentFacts": get: tags: - CommentFacts summary: Gets the comment facts. description: "Retrieves comments and their metadata for accounts in the specified period and engagement(s).\r\n " operationId: api/CommentFacts parameters: - name: period in: query description: 'possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99' schema: type: string - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" example: - AccountPeriodComment_Key: 294137 Engagement_Key: 4316 LegalEntity_Key: 294137 Period_Key: 14631 FiscalYearPeriod_Key: 256857 Account_Key: 294137 AddedByUsername: exampleuser@example.com AddedByName: Example Name CommentText: 'Ok - ' CommentAdded: '2015-05-07T07:20:40.973Z' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/CommentFacts" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/EngagementDimensions": get: tags: - EngagementDimensions summary: Gets the engagement dimensions. description: "Retrieves engagement configuration data including names, currencies, and identifiers.\r\n " operationId: api/EngagementDimensions parameters: - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" example: - Engagement_Key: 4316 EngagementName: John Doe Engagement EngagementCurrencyCode: USD EngagementCurrencyName: Dollar EngagementGuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ShortGuid: wH38Y1Tc application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/EngagementDim" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/LegalEntityDimensions": get: tags: - LegalEntityDimensions summary: Gets the legal entity dimensions. description: "This request should be used to retrieve information around legal entities such as legal entity names, addresses, and currency configurations – as seen under the legal entity tab on the engagement in Setup.\r\n " operationId: api/LegalEntityDimensions parameters: - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" example: - LegalEntity_Key: 7854 Engagement_Key: 4316 EntityCode: 1000x EntityName: Company 4000 Status: Active Address1: '' Address2: '' ZipCode: '' City: '' IsCrossEntity: Country: '240' EntityCurrencyCode: EUR EntityCurrencyName: Euro EntityInformation: '' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/LegalEntityDim" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/PeriodDimensions": get: tags: - PeriodDimensions summary: Gets the period dimensions. description: "This request should be used to retrieve information around fiscal periods and fiscal years, hereunder the fiscal period year name, the fiscal period names, and the corresponding date ranges. This would be information that is found under Administration->Fiscal years.\r\n " operationId: api/PeriodDimensions parameters: - name: period in: query description: 'possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99' schema: type: string - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" example: - Period_Key: 14631 Engagement_Key: 4316 LegalEntity_Key: 7854 FiscalYearName: '2015' FiscalYearStart: '2015-01-01T00:00:00Z' FiscalYearEnd: '2015-12-31T00:00:00Z' Period: 2015-01-31 Jan PeriodName: Jan PeriodSequence: 1 PeriodStart: '2015-01-01T00:00:00Z' PeriodEnd: '2015-01-31T00:00:00Z' PeriodFrequency: Month end PeriodStatus: Reopened PeriodCreatedDate: '2015-05-05T13:04:11.154Z' FiscalYearPeriodId: 6101 FiscalYearPeriodGuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6 application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/PeriodDim" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/TransactionExtraFieldFacts": get: tags: - TransactionExtraFieldFacts summary: Gets the transaction extra field facts. description: "This request should be used to retrieve information that is put on the custom fields (extra fields) for transactions for the specified engagement(s). The columns provided here will be the name of the extra field that is configured and it will be tied to the transactions using the Transaction_Key column.\r\n \ " operationId: api/TransactionExtraFieldFacts parameters: - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" example: - Transaction_Key: 1234 ColumnName: Varience Value: '1.65' application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionCustomFieldFacts" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read "/api/TransactionFacts": get: tags: - TransactionFacts summary: Gets the transaction facts. description: "This request should be used to retrieve transaction details including amounts, dates, who added the item, when it was added as well as the status for the specified transaction and account in the fiscal period for the selected engagement(s). This would be information that is found on the transactions on a given account under the Accounts and Status tab.\r\n " operationId: api/TransactionFacts parameters: - name: period in: query description: 'possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1(Default option) - Last three periods for filtered engagement(s), LastThirteen or 13 - Last thirteen periods for filtered engagement(s), LastTwentyFive or 25 - Last twenty five periods for filtered engagement(s), All or 99' schema: type: string - name: engagement in: query description: Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1 schema: type: string responses: '200': description: Success content: application/json;odata.metadata=minimal;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" example: - Engagement_Key: 1987 LegalEntity_Key: 2876 Transaction_Key: 3765 Period_Key: 4123 Account_Key: 5234 ItemAddedByUsername: abd@99x.io ItemAddedByName: Hex David TransactionType: Bank transaction TransactionStatus: Not Set AccountStatus: Approved AccountIsFinalized: 'False' AccountIsCarriedForward: 'False' ItemCreatedDate: '2022-12-06T08:23:18.919Z' AccountBalance: 2011 AccountUnidentifiedBalance: 0 AccountBalanceEngagement: 2011 AccountUnidentifiedBalanceEngagement: 0 BoookingDate: '2022-12-06T08:23:18.919Z' ReferenceOverJournalNumber: 'FED no: 000200562' Text: Fedex charges for package 002 Amount: 2000 AmountABS: 2001 CurrencyRate: 167.25 TransactionAmount: 12 Currency: 73 CurrencyName: Dollar CountOfAttachments: 0 AgeDays: 1261 AgeGroup: 90 Days or Older AccountPeriodTransaction_Key: 1234 EngagementGuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6 application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=minimal;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=full;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.metadata=none;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=true;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=true;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=false;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;odata.streaming=false;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;IEEE754Compatible=false: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" application/json;IEEE754Compatible=true: schema: type: array items: "$ref": "#/components/schemas/TransactionFacts" '400': description: Bad Request '404': description: Not Found '500': description: Server Error security: - basic: - analyticskpi_api.read - adra_personal_access_token: - analyticskpi_api.read components: schemas: AccountDim: required: - engagementGuid - account_Key - engagement_Key - legalEntity_Key type: object properties: engagementGuid: type: string format: uuid account_Key: type: integer format: int32 engagement_Key: type: integer format: int32 parentAccount_Key: type: integer format: int32 nullable: true accountClass: type: string nullable: true accountType: type: string nullable: true accountBaseClass: type: string nullable: true isKeyAccount: type: string nullable: true reconciliationType: type: string nullable: true riskType: type: string nullable: true prepareFrequency: type: string nullable: true approveFrequency: type: string nullable: true reviewFrequency: type: string nullable: true account_Id: type: integer format: int32 nullable: true parentAccountId: type: integer format: int32 nullable: true accountNumber: type: string nullable: true accountName: type: string nullable: true account: type: string nullable: true accountSubClass: type: string nullable: true systemCertify: type: string nullable: true carryForward: type: string nullable: true accountProcedure: type: string nullable: true accountPurpose: type: string nullable: true legalEntity_Key: type: integer format: int32 additionalProperties: false AccountFacts: required: - engagement_Key - legalEntity_Key - period_Key - fiscalYearPeriod_Key - account_Key - accountCreatedInPeriod - noOfDocuments - noOfPreparers - noOfApprovers - noOfReviewers - balance - balanceAbs - unidentifiedBalance - unIdentifiedBalanceAbs - balanceEngagement - balanceEngagementAbs - unidentifiedBalanceEngagement - unIdentifiedBalanceEngagementAbs - noOfRejects - engagementGuid - accountPeriodBalance type: object properties: engagement_Key: type: integer format: int32 legalEntity_Key: type: integer format: int32 period_Key: type: integer format: int32 fiscalYearPeriod_Key: type: integer format: int32 account_Key: type: integer format: int32 preparerUsername: type: string nullable: true preparerName: type: string nullable: true approverUsername: type: string nullable: true approverName: type: string nullable: true reviewerUsername: type: string nullable: true reviewerName: type: string nullable: true assignedToUsername: type: string nullable: true assignedToName: type: string nullable: true accountStatus: type: string nullable: true accountStatusReason: type: string nullable: true isFinalized: type: string nullable: true isCarriedForward: type: string nullable: true balancerAccountUrl: type: string nullable: true accountCreatedInPeriod: type: string format: date-time noOfDocuments: type: integer format: int32 noOfPreparers: type: integer format: int32 noOfApprovers: type: integer format: int32 noOfReviewers: type: integer format: int32 balance: type: number format: double balanceAbs: type: number format: double unidentifiedBalance: type: number format: double unIdentifiedBalanceAbs: type: number format: double balanceEngagement: type: number format: double balanceEngagementAbs: type: number format: double unidentifiedBalanceEngagement: type: number format: double unIdentifiedBalanceEngagementAbs: type: number format: double statusComment: type: string nullable: true accountPurpose: type: string nullable: true accountProcedure: type: string nullable: true extraField01: type: string nullable: true extraField02: type: string nullable: true extraField03: type: string nullable: true extraField04: type: string nullable: true extraField05: type: string nullable: true extraField06: type: string nullable: true extraField07: type: string nullable: true extraField08: type: string nullable: true extraField09: type: string nullable: true extraField10: type: string nullable: true noOfRejects: type: integer format: int32 accountPeriodComment_Key: type: integer format: int32 nullable: true accountPeriodTransaction_Key: type: integer format: int32 nullable: true preparedByName: type: string nullable: true preparedByUsername: type: string nullable: true approvedByName: type: string nullable: true approvedByUsername: type: string nullable: true reviewedByName: type: string nullable: true reviewedByUsername: type: string nullable: true preparedDate: type: string format: date-time nullable: true approvedDate: type: string format: date-time nullable: true reviewedDate: type: string format: date-time nullable: true rejectedDate: type: string format: date-time nullable: true engagementGuid: type: string format: uuid accountStatusPartial: type: string nullable: true accountPeriodBalance: type: number format: double balanceUpdatedDate: type: string format: date-time nullable: true accountStatusComments: type: string nullable: true accountStatusReasonText: type: string nullable: true reviewComment: type: string nullable: true additionalProperties: false AccountVarianceFacts: required: - accountPeriodVariance_Key - engagement_Key - period_Key - fiscalYearPeriod_Key - engagementGuid type: object properties: accountPeriodVariance_Key: type: integer format: int32 engagement_Key: type: integer format: int32 legalEntity_Key: type: integer format: int32 nullable: true account_Key: type: integer format: int32 nullable: true period_Key: type: integer format: int32 fiscalYearPeriod_Key: type: integer format: int32 varianceSetting_Key: type: integer format: int32 nullable: true currentPeriod_Key: type: integer format: int32 nullable: true comparedPeriod_Key: type: integer format: int32 nullable: true account_Id: type: integer format: int32 nullable: true engagementGuid: type: string format: uuid varianceType: type: integer format: int32 nullable: true varianceTypeText: type: string nullable: true currentPeriodBalance: type: number format: double nullable: true comparedPeriodBalance: type: number format: double nullable: true varianceAmount: type: number format: double nullable: true variancePercent: type: string nullable: true materiality: type: integer format: int32 nullable: true materialityText: type: string nullable: true explanation: type: string nullable: true documentedDate: type: string format: date-time nullable: true documentedBy: type: string nullable: true isActive: type: boolean nullable: true additionalProperties: false CommentFacts: required: - engagement_Key - legalEntity_Key - period_Key - fiscalYearPeriod_Key - account_Key - commentAdded - accountPeriodComment_Key - userKey - engagementGuid type: object properties: engagement_Key: type: integer format: int32 legalEntity_Key: type: integer format: int32 period_Key: type: integer format: int32 fiscalYearPeriod_Key: type: integer format: int32 account_Key: type: integer format: int32 addedByUsername: type: string nullable: true addedByName: type: string nullable: true commentText: type: string nullable: true commentAdded: type: string format: date-time accountPeriodComment_Key: type: integer format: int32 userKey: type: integer format: int32 engagementGuid: type: string format: uuid additionalProperties: false EngagementDim: required: - engagement_Key - engagementGuid type: object properties: engagement_Key: type: integer format: int32 engagementName: type: string nullable: true engagementCurrencyCode: type: string nullable: true engagementCurrencyName: type: string nullable: true engagementGuid: type: string format: uuid shortGuid: type: string nullable: true additionalProperties: false LegalEntityDim: required: - legalEntity_Key - engagement_Key - engagementGuid type: object properties: legalEntity_Key: type: integer format: int32 engagement_Key: type: integer format: int32 entityCode: type: string nullable: true entityName: type: string nullable: true status: type: string nullable: true address1: type: string nullable: true address2: type: string nullable: true zipCode: type: string nullable: true city: type: string nullable: true isCrossEntity: type: boolean nullable: true country: type: string nullable: true entityCurrencyCode: type: string nullable: true entityCurrencyName: type: string nullable: true entityInformation: type: string nullable: true engagementGuid: type: string format: uuid additionalProperties: false PeriodDim: required: - period_Key - engagement_Key - legalEntity_Key - periodSequence - engagementGuid - fiscalYearPeriodId - fiscalYearPeriodGuid type: object properties: period_Key: type: integer format: int32 engagement_Key: type: integer format: int32 legalEntity_Key: type: integer format: int32 fiscalYearName: type: string nullable: true fiscalYearStart: type: string format: date-time nullable: true fiscalYearEnd: type: string format: date-time nullable: true period: type: string nullable: true periodName: type: string nullable: true periodSequence: type: integer format: int32 periodStart: type: string format: date-time nullable: true periodEnd: type: string format: date-time nullable: true periodFrequency: type: string nullable: true periodStatus: type: string nullable: true periodCreatedDate: type: string format: date-time nullable: true engagementGuid: type: string format: uuid fiscalYearPeriodId: type: integer format: int32 fiscalYearPeriodGuid: type: string format: uuid additionalProperties: false TransactionCustomFieldFacts: required: - transaction_Key - engagementGuid type: object properties: transaction_Key: type: integer format: int32 columnName: type: string nullable: true value: type: string nullable: true engagementGuid: type: string format: uuid additionalProperties: false TransactionFacts: required: - engagement_Key - legalEntity_Key - transaction_Key - period_Key - fiscalYearPeriod_Key - account_Key - itemCreatedDate - accountBalance - accountUnidentifiedBalance - accountBalanceEngagement - accountUnidentifiedBalanceEngagement - boookingDate - amount - amountABS - currencyRate - transactionAmount - currency - countOfAttachments - ageDays - engagementGuid type: object properties: engagement_Key: type: integer format: int32 legalEntity_Key: type: integer format: int32 transaction_Key: type: integer format: int32 period_Key: type: integer format: int32 fiscalYearPeriod_Key: type: integer format: int32 account_Key: type: integer format: int32 itemAddedByUsername: type: string nullable: true itemAddedByName: type: string nullable: true transactionType: type: string nullable: true transactionStatus: type: string nullable: true accountStatus: type: string nullable: true accountIsFinalized: type: string nullable: true accountIsCarriedForward: type: string nullable: true itemCreatedDate: type: string format: date-time accountBalance: type: number format: double accountUnidentifiedBalance: type: number format: double accountBalanceEngagement: type: number format: double accountUnidentifiedBalanceEngagement: type: number format: double boookingDate: type: string format: date-time referenceOverJournalNumber: type: string nullable: true text: type: string nullable: true amount: type: number format: double amountABS: type: number format: double currencyRate: type: number format: double transactionAmount: type: number format: double currency: type: integer format: int32 currencyName: type: string nullable: true countOfAttachments: type: integer format: int32 ageDays: type: integer format: int32 ageGroup: type: string nullable: true accountPeriodTransaction_Key: type: integer format: int32 nullable: true engagementGuid: type: string format: uuid additionalProperties: false securitySchemes: adra_personal_access_token: type: http description: |- This API uses OAuth 2.0 Bearer tokens for authentication. **Authentication Token**: You can obtain a token using: - **Personal Access Tokens**: Generate these tokens from your [user account settings](https://setup.adra.com/profile/access) Once you have a token, include it in the `Authorization` header of your requests: ``` Authorization: Bearer YOUR_TOKEN_HERE ``` Ensure that you keep your tokens secure and do not share them publicly. scheme: bearer basic: type: http description: Basic Authorization header using the Bearer scheme. Use API key in the username field. if engagement guid provided as password data will be filtered. scheme: basic