Accounts

openapi: 3.0.3 info: title: General Ledger API - Accounts version: v1 description: API to interact with General Ledger contact: name: General Ledger url: https://www.jackhenry.com/ email: DC-LedgerServices-Product@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Accounts description: APIs for institution specific general ledger accounts paths: /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts: post: operationId: AccountAdd tags: - Accounts summary: Create a General Ledger Account record. description: API to post a GL Account to an institution parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The General Ledger record to be created. content: application/json: schema: type: object required: - accountNumber - accountTitle - accountType properties: accountNumber: type: string description: The account number assigned to the GL account. nullable: false minimum: 1 maximum: 99999999 example: '253100' accountTitle: type: string description: The name of the GL account. nullable: false maxLength: 40 example: Accounts Payable accountType: type: string description: The type of GL account. nullable: false example: Liability enum: - Asset - Equity - Expense - Income - Liability currencyType: type: string description: The type of currency of the GL account. nullable: true default: USD accountStatus: default: Open description: Account status defaults to open. nullable: true type: string enum: - Open - Closed - Control - Locked additionalProperties: false responses: '201': description: Account Created content: application/json: schema: type: object required: - id properties: id: allOf: - type: string format: uuid description: The unique general ledger account identifier. nullable: false description: The unique id to the GL account created. additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Validation Errors value: type: general-ledger/request-constraint-violation title: Bad request details: - Account Number must be a valid number - Account Number must be between 1 and 8 digits - A GL account with this Account Number already exists - Account Title cannot be blank - Account Title cannot be more than 40 characters - Account Type must be either Asset, Liability, Equity, Income, or Expense - Currency Type must be USD - Account Status not valid - GL {Income or Expense} accounts cannot have a status of Control '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}: get: operationId: AccountRead tags: - Accounts summary: Read a General Ledger Account record. description: API to read a GL Account in an institution. parameters: - name: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - id - lastModifiedDate - openedDate - accountNumber - accountStatus - accountTitle - accountType - balance properties: id: type: string format: uuid description: The unique general ledger account identifier. nullable: false lastModifiedDate: type: string format: date-time description: The timestamp of the last update to the account. nullable: false openedDate: type: string format: date-time description: The timestamp of when the account was opened. nullable: false accountNumber: type: string description: The account number assigned to the GL account. nullable: false minimum: 1 maximum: 99999999 example: '253100' accountStatus: type: string description: The status of the GL account. nullable: false enum: - Open - Closed - Control - Locked accountTitle: type: string description: The name of the GL account. nullable: false maxLength: 40 example: Accounts Payable accountType: type: string description: The type of GL account. nullable: false example: Liability enum: - Asset - Equity - Expense - Income - Liability balance: 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 lastTransactionDate: type: string format: date-time description: The timestamp of the last transaction. nullable: true links: type: array items: type: string description: The link of the GL account. nullable: true maxLength: 80 example: DepositBalance nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: AccountUpdate tags: - Accounts summary: Update a General Ledger Account record. description: API to update a GL Account in an institution. parameters: - name: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The request. content: application/json: schema: type: object required: - accountTitle - accountStatus properties: accountTitle: type: string description: The name of the GL account. nullable: false maxLength: 40 example: Accounts Payable accountStatus: type: string description: The status of the GL account. nullable: false enum: - Open - Closed - Control - Locked accountNumber: type: string description: The updated GL account number. additionalProperties: false responses: '204': description: Account Updated '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Validation Errors value: type: general-ledger/request-constraint-violation title: Bad request details: - Account Title cannot be blank - Account Title cannot be more than 40 characters - Account Status not valid - Account Number must be a valid number - Account Number must be between 1 and 8 digits - A GL account with this Account Number already exists accountStatusControl: summary: Control account status cannot be updated value: type: general-ledger/control-account-update-not-allowed title: Control Account update not allowed details: - A GL account that has a status of Control cannot have its status changed updateToAccountStatusControl: summary: Cannot update account status to control value: type: general-ledger/invalid-account-status-control title: Account update not allowed to status control details: - A GL account cannot be updated to have the status of Control closedAccountUpdateNot: summary: Cannot close an account having a link value: type: general-ledger/closed-account-update-not-allowed title: Account update not allowed to status closed details: - The GL account cannot be Closed since it has a link record tied to it accountBalanceNotZero: summary: Account balance must be zero to update status to closed value: type: general-ledger/account-balance-not-zero-closed-status title: Account balance not zero for closed status details: - The GL account balance must be zero before it can be closed '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: AccountsDelete tags: - Accounts summary: API to delete a General Ledger Account description: API to delete GL Account record. parameters: - name: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '204': description: Account Deleted '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: accountBalanceNotZero: summary: Account balance Not Zero value: type: general-ledger/account-balance-must-be-zero title: Account balance not zero details: - The GL Account must have had a zero balance for 36 months accountHasTransactionHistory: summary: Account has transaction history value: type: general-ledger/account-has-transaction-history title: Account has transaction history details: - The GL Account has transaction history accountNotClosed: summary: Account not closed value: type: general-ledger/account-must-be-closed title: Account not closed details: - The GL Account must be closed before being deleted '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts-search: post: operationId: AccountsSearch tags: - Accounts summary: API to search for General Ledger Account(s) description: Get a list of GL account(s) based on search criteria 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: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string - name: Query in: query required: false description: The specified api will search both the account title and account number for the query string. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true requestBody: content: application/json: schema: type: object properties: accountNumber: type: string description: The account number to be searched. nullable: true example: '100' accountStatus: type: array items: type: string description: The status of the GL account. nullable: false enum: - Open - Closed - Control - Locked nullable: true accountType: type: array items: type: string description: The type of GL account. nullable: false example: Liability enum: - Asset - Equity - Expense - Income - Liability nullable: true accountTitle: type: string description: The name of the GL account. nullable: false maxLength: 40 example: Accounts Payable link: type: string description: The link of the GL account. nullable: true maxLength: 80 example: DepositBalance count: type: number description: The number of records to return. minimum: 0 maximum: 500 default: 50 format: int32 nullable: true example: 100 offset: type: number description: The number of records to skip before returning the result. Default to 0. default: 0 format: int32 nullable: true example: 50 additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - results - paging properties: results: type: array items: type: object required: - id - accountNumber - accountStatus - accountTitle - accountType - balance properties: id: allOf: - type: string format: uuid description: The unique general ledger account identifier. nullable: false description: The id assigned to the GL account. accountNumber: type: string description: The account number to be searched. nullable: false accountStatus: type: string description: The status of the GL account. nullable: false enum: - Open - Closed - Control - Locked accountTitle: type: string description: The account title to be searched. nullable: false accountType: type: string description: The type of GL account. nullable: false example: Liability enum: - Asset - Equity - Expense - Income - Liability balance: 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 links: type: array items: type: string description: The link of the GL account. nullable: true maxLength: 80 example: DepositBalance nullable: false additionalProperties: false nullable: false paging: nullable: false type: object required: - nextOffset - results properties: nextOffset: type: string description: The next offset is the start position of the read pointer for pagination. results: type: integer description: The number of records included in the response. total: type: integer nullable: true description: The total number of records the server has available for the request. additionalProperties: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Validation Errors value: type: general-ledger/request-constraint-violation title: Bad request details: - Account Type must be either Asset, Liability, Equity, Income, or Expense - Account Status not valid - Sort By must be AccountNumber, AccountStatus, AccountTitle, AccountType, or Link - Sort Direction must be either asc or desc '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/daily-balances: get: operationId: AccountDailyBalance tags: - Accounts summary: API to get account balance history description: API to get a list of an account's balance history 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: StartDate in: query required: false description: If a start date is provided, records older than the start date will be filtered from the results schema: type: string format: date nullable: true - name: EndDate in: query required: false description: If a end date is provided, records newer than the end date will be filtered from the results. If not provided, the current day will be used for the end date. schema: type: string format: date nullable: true - 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: ?count=100 schema: type: string default: '100' - 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: ?offset=50 schema: type: string default: '0' - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - results - paging properties: results: type: array items: type: object required: - createdDate - balance properties: createdDate: format: date example: '2024-01-01' type: string description: Business date of the balanced transaction set. nullable: false balance: 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 additionalProperties: false nullable: false paging: nullable: false type: object required: - nextOffset - results properties: nextOffset: type: string description: The next offset is the start position of the read pointer for pagination. results: type: integer description: The number of records included in the response. total: type: integer nullable: true description: The total number of records the server has available for the request. additionalProperties: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Validation Errors value: type: general-ledger/request-constraint-violation title: Bad request details: - Start Date must be a valid date - End Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/accumulative-balances: get: operationId: AccountAccumulativeBalances tags: - Accounts summary: API to get an account's accumulative balances description: API to get a list of an account's accumulative balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false responses: '200': description: Success content: application/json: schema: type: array items: type: object required: - id - balance - effectiveDate properties: id: type: string format: uuid nullable: false balance: 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 effectiveDate: type: string format: date nullable: false additionalProperties: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/accumulative-balances/branch-cost-center: get: operationId: AccountAccumulativeBranchCostCenterBalances tags: - Accounts summary: API to get accumulative balances grouped by branch and cost center description: API to get accumulative balances grouped by branch and cost center 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true - name: timeZone in: query required: false description: IANA timezone. If not provided, the service default timezone is used. schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: type: array items: type: object required: - branchId - costCenter - balance properties: branchId: type: string nullable: false costCenter: type: string nullable: false balance: 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 additionalProperties: false '400': description: The request is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/delta-balances: get: operationId: AccountDeltaBalances tags: - Accounts summary: API to get an account's delta balances description: API to get a list of an account's delta balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false responses: '200': description: Success content: application/json: schema: type: array items: type: object required: - id - balance - effectiveDate - transactionCount properties: id: type: string format: uuid nullable: false balance: 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 effectiveDate: type: string format: date nullable: false transactionCount: type: integer format: int64 nullable: false additionalProperties: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/delta-balances/{runDate}: get: operationId: AccountDeltaBalanceByDate tags: - Accounts summary: API to get an account's delta balance for a specific date description: API to get a single delta balance by date for an account 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: runDate in: path required: true description: Date in YYYY-MM-DD format. schema: type: string format: date nullable: false responses: '200': description: Success content: application/json: schema: type: object required: - id - balance - effectiveDate - transactionCount properties: id: type: string format: uuid nullable: false balance: 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 effectiveDate: type: string format: date nullable: false transactionCount: type: integer format: int64 nullable: false additionalProperties: false '400': description: The request is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances-search: get: operationId: AccountBalanceSearch tags: - Accounts summary: API to search account balances description: API to search accumulative and delta balances with transaction counts 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: StartDate in: query required: false description: If a start date is provided, records older than the start date will be filtered from the results schema: type: string format: date nullable: true - name: EndDate in: query required: false description: If a end date is provided, records newer than the end date will be filtered from the results. If not provided, the current day will be used for the end date. schema: type: string format: date nullable: true - 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: ?count=100 schema: type: string default: '100' - 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: ?offset=50 schema: type: string default: '0' - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - results - paging properties: results: type: array items: type: object required: - createdDate - accumulativeBalance - deltaBalance - transactionCount properties: createdDate: type: string format: date nullable: false accumulativeBalance: 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 deltaBalance: 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 transactionCount: type: integer format: int64 nullable: false additionalProperties: false nullable: false paging: nullable: false type: object required: - nextOffset - results properties: nextOffset: type: string description: The next offset is the start position of the read pointer for pagination. results: type: integer description: The number of records included in the response. total: type: integer nullable: true description: The total number of records the server has available for the request. additionalProperties: false additionalProperties: false '400': description: The request is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/monthly-averages: get: operationId: AccountMonthlyAverages tags: - Accounts summary: API to get an account's monthly averages description: API to get an account's monthly averages 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - monthlyAverages properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 monthlyAverages: type: array items: type: object required: - calendarMonth - average properties: calendarMonth: type: integer format: int32 example: 1 minimum: 1 maximum: 12 nullable: false average: 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 additionalProperties: false nullable: false additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/quarterly-averages: get: operationId: AccountQuarterlyAverages tags: - Accounts summary: API to get an account's quarterly averages description: API to get an account's quarterly averages 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - quarterlyAverages properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 quarterlyAverages: type: array items: type: object required: - fiscalQuarter - average properties: fiscalQuarter: type: integer format: int32 minimum: 1 maximum: 4 example: 1 nullable: false average: 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 additionalProperties: false nullable: false additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/year-to-date-averages: get: operationId: AccountYearToDateAverages tags: - Accounts summary: API to get an account's year-to-date averages description: API to get an account's year-to-date averages 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - average properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 average: 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 additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/month-ending: get: operationId: AccountMonthEndingBalances tags: - Accounts summary: API to get an account's month-ending balances description: API to get an account's month-ending balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - monthEndingBalances properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 monthEndingBalances: type: array items: type: object required: - calendarMonth - balance properties: calendarMonth: type: integer format: int32 example: 1 minimum: 1 maximum: 12 nullable: false balance: 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 additionalProperties: false nullable: false additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/quarter-ending: get: operationId: AccountQuarterEndingBalances tags: - Accounts summary: API to get an account's quarter-ending balances description: API to get an account's quarter-ending balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalQuarter - balance properties: fiscalQuarter: type: integer format: int32 nullable: false minimum: 1 maximum: 4 example: 1 balance: 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 additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/month-to-date: get: operationId: AccountMonthToDateBalances tags: - Accounts summary: API to get an account's month-to-date balances description: API to get an account's month-to-date balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - monthToDateBalances properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 monthToDateBalances: type: array items: type: object required: - calendarMonth - balance properties: calendarMonth: type: integer format: int32 example: 1 minimum: 1 maximum: 12 nullable: false balance: 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 additionalProperties: false nullable: false additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request in general ledger. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Unexpected General Ledger error value: type: general-ledger/internal-server-error title: Unexpected error details: - Sorry, something unexpected happened. Please try again. /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/quarter-to-date: get: operationId: AccountQuarterToDateBalances tags: - Accounts summary: API to get an account's quarter-to-date balances description: API to get an account's quarter-to-date balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalQuarter - balance properties: fiscalQuarter: type: integer format: int32 nullable: false minimum: 1 maximum: 4 example: 1 balance: 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 additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/balances/year-to-date: get: operationId: AccountYearToDateBalances tags: - Accounts summary: API to get an account's year-to-date balances description: API to get an account's year-to-date balances 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: branchId in: query required: false description: The unique identifier for the branch associated with the GL account. schema: type: string nullable: true - name: costCenter in: query required: false description: The unique identifier for the cost center associated with the GL account. schema: type: string nullable: true - name: runDate in: query required: false description: Results will be returned as of the date provided. If not provided, the current day will be used. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object required: - fiscalYears properties: fiscalYears: type: array items: type: object required: - fiscalYear - balance properties: fiscalYear: type: integer format: int32 nullable: false example: 2024 balance: 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 additionalProperties: false nullable: false additionalProperties: false '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Invalid Run date value: type: general-ledger/request-constraint-violation title: Bad request details: - Run Date must be a valid date '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/general-ledger/v1/{InstitutionUniversalId}/accounts/{Id}/transactions-search: post: x-ignoreRules: - jhapi-000-Content-Definitions operationId: AccountTransactionSearch tags: - Accounts summary: API to get account Transaction history description: API to search an Account's Transaction history 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: Id in: path required: true description: The unique general ledger account identifier. schema: type: string format: uuid nullable: false - name: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string requestBody: description: A request containing the search criteria content: application/json: schema: type: object properties: startDate: format: date example: '2024-01-01' type: string description: Designates the starting point for the search. If none is provided, the search will start using the first transaction posted to the account. nullable: true endDate: format: date example: '2024-03-01' type: string description: Designates the ending point for the search. If none is provided, the search will default endDate to today. nullable: true effectiveStartDate: format: date example: '2024-01-01' type: string description: Designates the starting point for the search based on the effective date. If none is provided, the search will start using the first transaction posted to the account. nullable: true effectiveEndDate: format: date example: '2024-01-01' type: string description: Designates the ending point for the search based on the effective date. If none is provided, the search will stop at the last transaction posted to the account. nullable: true postedStartDate: format: date example: '2024-01-01' type: string description: Designates the starting point for the search based on the posted date. If none is provided, the search will start using the first transaction posted to the account. nullable: true postedEndDate: format: date example: '2024-01-01' type: string description: Designates the ending point for the search based on the posted date. If none is provided, the search will stop at the last transaction posted to the account. nullable: true lowAmount: type: string description: Includes transactions with an amount greater than or equal to the lowAmount. nullable: true highAmount: type: string description: Includes transactions with an amount less than or equal to the highAmount. nullable: true debitCredit: type: string description: The transaction type to filter on. If "debit" is sent as the "DebitCredit" value, only debit transactions will be returned. enum: - Debit - Credit nullable: true entryType: type: array description: The list of entry types to filter on. If ["Manual", "Journal"] is sent as the "EntryType" value, the account's manual and journal transactions will be returned. items: type: string example: - Manual - Journal nullable: true count: type: number description: The number of records to return. minimum: 0 maximum: 500 default: 50 format: int32 nullable: true example: 100 offset: type: number description: The number of records to skip before returning the result. Default to 0. default: 0 format: int32 nullable: true example: 50 additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - results - paging properties: results: type: array items: type: object required: - id - transactionSetId - effectiveDate - postedDate - description - entryType - reference - debitCredit - amount - runningBalance - createdBy - branchId - costCenter properties: id: allOf: - type: string format: uuid description: The unique general ledger account identifier. nullable: false description: The GL account to send the transaction set to. transactionSetId: type: string format: uuid description: The transaction set id the transaction is tied to. nullable: false effectiveDate: type: string description: The business date the transaction applies to. nullable: false postedDate: type: string format: date-time description: The timestamp when the transactions was posted. nullable: false description: type: string description: Description contained within the transaction. nullable: false entryType: type: string description: The entry or input point of the transaction. nullable: false reference: type: string nullable: false description: Any id to link the transaction to another domain. debitCredit: allOf: - enum: - Debit - Credit type: string description: Defines if the transaction debits or credits the account. nullable: false 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 runningBalance: 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 createdBy: type: string example: Jane Doe description: The user who created the transaction set. nullable: false system: type: string description: The system the transaction set originated from. nullable: true journal: type: string description: The journal that generated the entry. nullable: true branchId: type: string description: Used to identify the physical or non-physical location an account belongs to. nullable: false costCenter: type: string description: Used to identify a part of the organization such as a department, team, or project. additionalProperties: false nullable: false paging: nullable: false type: object required: - nextOffset - results properties: nextOffset: type: string description: The next offset is the start position of the read pointer for pagination. results: type: integer description: The number of records included in the response. total: type: integer nullable: true description: The total number of records the server has available for the request. additionalProperties: false additionalProperties: false text/csv: schema: type: string format: binary '400': description: The request body is invalid. See the response body for more information. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: badRequest: summary: Validation Errors value: type: general-ledger/request-constraint-violation title: Bad request details: - Sort By must be effectiveDate or postedDate - Sort Direction must be either asc or desc - Start Date must be a valid date - End Date must be a valid date - Effective Start Date must be a valid date - Effective End Date must be a valid date - Posted Start Date must be a valid date - Posted End Date must be a valid date - DebitCredit must be debit or credit '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: 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. '404': description: 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. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field